Skip to main content

Published App Integration

View as Markdown

PublishedOAuthAppIntegration object​

A published OAuth app integration enables an OAuth app published by <Databricks>, such as Power BI or Tableau Desktop, for the account. <Databricks> manages the app's client ID, redirect URLs and scopes; the integration only sets the lifetimes of the tokens issued to the app. To register your own application, use a custom OAuth app integration instead. See https://docs.databricks.com/aws/en/integrations/enable-disable-oauth.

app_idstring

ID of the published OAuth app, as returned in app_id by the list of published OAuth apps.

integration_idstring

ID of the published OAuth app integration in the account.

namestring

Display name of the published OAuth app.

token_access_policyobject

Lifetimes of the access and refresh tokens issued to the app.

Show child attributesHide child attributes
access_token_ttl_in_minutesint32[ 5 .. 1440 ]

Lifetime of access tokens, in minutes.

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Lifetime of refresh tokens, in minutes. Must not be shorter than access_token_ttl_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. Can only be set when enable_single_use_refresh_tokens is true, and must be at least refresh_token_ttl_in_minutes and at most 525600 (one year). 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

ID of the user who created the integration.

create_timestring

Time the integration was created, as an ISO 8601 timestamp.

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

ID of the published OAuth app integration.

Response​

Returns the PublishedOAuthAppIntegration object.

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 <Databricks> account.

API scopes: authentication

Parameters​

account_idstringRequiredpath
page_tokenstringquery

Token from the next_page_token field of a previous response. Omit it to request the first page.

page_sizeint32query

Maximum number of integrations to return in one page, at most 1000.

Default: 100

Response​

Returns a list of PublishedOAuthAppIntegration objects.

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

ID of the published OAuth app to enable, as returned in app_id by the list of published OAuth apps. The short legacy IDs of the original published apps, such as power-bi and tableau-desktop, are also accepted. The request fails if the app is already enabled for the account.

token_access_policyobject

Lifetimes of the tokens issued to the app. If omitted, the app's default token lifetimes apply. If set, both TTL fields are required.

Show child attributesHide child attributes
access_token_ttl_in_minutesint32[ 5 .. 1440 ]

Lifetime of access tokens, in minutes.

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Lifetime of refresh tokens, in minutes. Must not be shorter than access_token_ttl_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. Can only be set when enable_single_use_refresh_tokens is true, and must be at least refresh_token_ttl_in_minutes and at most 525600 (one year). 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

ID of the published OAuth app integration.

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

ID of the published OAuth app integration to update.

Request body​

token_access_policyobject

New token lifetimes for the app. Both TTL fields are required when the policy is set; the single-use refresh token settings keep their current values when omitted. If the policy is omitted, the integration is left unchanged.

Show child attributesHide child attributes
access_token_ttl_in_minutesint32[ 5 .. 1440 ]

Lifetime of access tokens, in minutes.

refresh_token_ttl_in_minutesint32[ 5 .. 129600 ]

Lifetime of refresh tokens, in minutes. Must not be shorter than access_token_ttl_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. Can only be set when enable_single_use_refresh_tokens is true, and must be at least refresh_token_ttl_in_minutes and at most 525600 (one year). 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.

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. The app can no longer be used to sign in to the account until it is enabled again with PublishedAppIntegration/create.

API scopes: authentication

Parameters​

account_idstringRequiredpath
integration_idstringRequiredpath

ID of the published OAuth app integration to delete.

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: 895c3b88-fcc9-11ed-be56-0242ac120002

client_idstring

Client ID of the published OAuth app. The app sends it as 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.