Published App Integration

View as Markdown

Get OAuth Published App IntegrationGET /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}Get published oauth app integrationsGET /api/2.0/accounts/{account_id}/oauth2/published-app-integrationsCreate Published OAuth App IntegrationPOST /api/2.0/accounts/{account_id}/oauth2/published-app-integrationsUpdates Published OAuth App IntegrationPATCH /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}Delete Published OAuth App IntegrationDELETE /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}Get all the published OAuth appsGET /api/2.0/accounts/{account_id}/oauth2/published-apps

PublishedOAuthAppIntegration object

app_idstring

App-id of the published app integration

integration_idstring

Unique integration id for the published OAuth app

namestring

Display name of the published OAuth app

token_access_policyobject

Token access policy

Show child attributesHide child attributes

access_token_ttl_in_minutesint32[ 5 .. 1440 ]

access token time to live in minutes

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Refresh token time to live in minutes. When single-use refresh tokens are enabled, this represents the TTL of an individual refresh token. If the refresh token is used before it expires, a new one is issued with a renewed individual TTL.

enable_single_use_refresh_tokensbooleanBeta

Whether to enable single-use refresh tokens (refresh token rotation). If this feature is enabled, upon successfully getting a new access token using a refresh token, <Databricks> will issue a new refresh token along with the access token in the response and invalidate the old refresh token. The client should use the new refresh token to get access tokens in future requests.

absolute_session_lifetime_in_minutesint32Beta

Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature is enabled. This is the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is issued during refresh token rotation, it will inherit the same absolute TTL as the old refresh token. In other words, this represents the maximum amount of time a user can stay logged in without re-authenticating.

created_byint64

create_timestring

View as Markdown

The PublishedOAuthAppIntegration object

{
  "app_id": "string",
  "integration_id": "string",
  "name": "string",
  "token_access_policy": {
    "access_token_ttl_in_minutes": 5,
    "refresh_token_ttl_in_minutes": 5,
    "enable_single_use_refresh_tokens": true,
    "absolute_session_lifetime_in_minutes": 0
  },
  "created_by": 0,
  "create_time": "string"
}

Get OAuth Published App Integration GA

GET /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}

Gets the Published OAuth App Integration for the given integration id.

API scopes: authentication

Parameters

account_idstringRequiredpath

integration_idstringRequiredpath

Response

Returns the PublishedOAuthAppIntegration object.

View as Markdown

Response

{
  "app_id": "string",
  "integration_id": "string",
  "name": "string",
  "token_access_policy": {
    "access_token_ttl_in_minutes": 5,
    "refresh_token_ttl_in_minutes": 5,
    "enable_single_use_refresh_tokens": true,
    "absolute_session_lifetime_in_minutes": 0
  },
  "created_by": 0,
  "create_time": "string"
}

Get published oauth app integrations GA

GET /api/2.0/accounts/{account_id}/oauth2/published-app-integrations

Get the list of published OAuth app integrations for the specified <Account>

API scopes: authentication

Parameters

account_idstringRequiredpath

page_tokenstringquery

page_sizeint32query

Default: 100

Response

Returns a list of PublishedOAuthAppIntegration objects.

View as Markdown

Response

{
  "apps": [
    {
      "app_id": "string",
      "integration_id": "string",
      "name": "string",
      "token_access_policy": {},
      "created_by": 0,
      "create_time": "string"
    }
  ],
  "next_page_token": "string"
}

Create Published OAuth App Integration GA

POST /api/2.0/accounts/{account_id}/oauth2/published-app-integrations

Create Published OAuth App Integration.

You can retrieve the published OAuth app integration via PublishedAppIntegration/get.

API scopes: authentication

Parameters

account_idstringRequiredpath

Request body

app_idstring

App id of the OAuth published app integration. For example power-bi, tableau-deskop

token_access_policyobject

Token access policy

Show child attributesHide child attributes

access_token_ttl_in_minutesint32[ 5 .. 1440 ]

access token time to live in minutes

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Refresh token time to live in minutes. When single-use refresh tokens are enabled, this represents the TTL of an individual refresh token. If the refresh token is used before it expires, a new one is issued with a renewed individual TTL.

enable_single_use_refresh_tokensbooleanBeta

Whether to enable single-use refresh tokens (refresh token rotation). If this feature is enabled, upon successfully getting a new access token using a refresh token, <Databricks> will issue a new refresh token along with the access token in the response and invalidate the old refresh token. The client should use the new refresh token to get access tokens in future requests.

absolute_session_lifetime_in_minutesint32Beta

Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature is enabled. This is the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is issued during refresh token rotation, it will inherit the same absolute TTL as the old refresh token. In other words, this represents the maximum amount of time a user can stay logged in without re-authenticating.

Response

integration_idstring

Unique integration id for the published OAuth app

View as Markdown

Request

{
  "app_id": "power-bi",
  "token_access_policy": {
    "access_token_ttl_in_minutes": 120,
    "refresh_token_ttl_in_minutes": 200
  }
}

Response

{
  "integration_id": "c1b137c2-b832-1abc-ad12-995a0209e213"
}

Updates Published OAuth App Integration GA

PATCH /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}

Updates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via PublishedAppIntegration/get.

API scopes: authentication

Parameters

account_idstringRequiredpath

integration_idstringRequiredpath

Request body

token_access_policyobject

Token access policy to be updated in the published OAuth app integration

Show child attributesHide child attributes

access_token_ttl_in_minutesint32[ 5 .. 1440 ]

access token time to live in minutes

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Refresh token time to live in minutes. When single-use refresh tokens are enabled, this represents the TTL of an individual refresh token. If the refresh token is used before it expires, a new one is issued with a renewed individual TTL.

enable_single_use_refresh_tokensbooleanBeta

Whether to enable single-use refresh tokens (refresh token rotation). If this feature is enabled, upon successfully getting a new access token using a refresh token, <Databricks> will issue a new refresh token along with the access token in the response and invalidate the old refresh token. The client should use the new refresh token to get access tokens in future requests.

absolute_session_lifetime_in_minutesint32Beta

Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature is enabled. This is the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is issued during refresh token rotation, it will inherit the same absolute TTL as the old refresh token. In other words, this represents the maximum amount of time a user can stay logged in without re-authenticating.

View as Markdown

Request

{
  "token_access_policy": {
    "access_token_ttl_in_minutes": 120,
    "refresh_token_ttl_in_minutes": 200
  }
}

Response

{}

Delete Published OAuth App Integration GA

DELETE /api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}

Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app integration via PublishedAppIntegration/get.

API scopes: authentication

Parameters

account_idstringRequiredpath

integration_idstringRequiredpath

View as Markdown

Response

{}

Get all the published OAuth apps GA

GET /api/2.0/accounts/{account_id}/oauth2/published-apps

Get all the available published OAuth apps in <Databricks>.

API scopes: authentication

Parameters

account_idstringRequiredpath

The account ID.

page_tokenstringquery

A token that can be used to get the next page of results.

page_sizeint32[ 1 .. 100 ]query

The max number of OAuth published apps to return in one page.

Default: 100

Response

appsarray of object

List of Published OAuth Apps.

Show child attributesHide child attributes

app_idstring

Unique ID of the published OAuth app.

Example: 01234567-1234-5678-90ab-76543210

client_idstring

Client ID of the published OAuth app. It is the client_id in the OAuth flow

Example: databricks-cli

namestring

The display name of the published OAuth app.

Example: Databricks CLI

descriptionstring

Description of the published OAuth app.

is_confidential_clientboolean

Whether the published OAuth app is a confidential client. It is always false for published OAuth apps.

Default: false

redirect_urlsarray of string

Redirect URLs of the published OAuth app.

scopesarray of string

Required scopes for the published OAuth app.

next_page_tokenstring

A token that can be used to get the next page of results. If not present, there are no more results to show.

View as Markdown

Response

{
  "apps": [
    {
      "app_id": "01234567-1234-5678-90ab-76543210",
      "client_id": "databricks-cli",
      "name": "Databricks CLI",
      "description": "string",
      "is_confidential_client": false,
      "redirect_urls": [
        "http://localhost:8020"
      ],
      "scopes": [
        "sql",
        "offline_access"
      ]
    }
  ],
  "next_page_token": "string"
}