a.custom_app_integration: OAuth Custom App Integration

class databricks.sdk.service.oauth2.CustomAppIntegrationAPI

These APIs enable administrators to manage custom OAuth app integrations, which is required for adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.

create([, confidential: Optional[bool], name: Optional[str], redirect_urls: Optional[List[str]], scopes: Optional[List[str]], token_access_policy: Optional[TokenAccessPolicy], user_authorized_scopes: Optional[List[str]]]) → CreateCustomAppIntegrationOutput

Create Custom OAuth App Integration.

Create Custom OAuth App Integration.

You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.

Parameters:

  • confidential – bool (optional) This field indicates whether an OAuth client secret is required to authenticate this client.

  • name – str (optional) Name of the custom OAuth app

  • redirect_urls – List[str] (optional) List of OAuth redirect urls

  • scopes – List[str] (optional) OAuth scopes granted to the application. Supported scopes: all-apis, sql, offline_access, openid, profile, email.

  • token_access_policy – TokenAccessPolicy (optional) Token access policy

  • user_authorized_scopes – List[str] (optional) Scopes that will need to be consented by end user to mint the access token. If the user does not authorize the access token will not be minted. Must be a subset of scopes.

Returns:

CreateCustomAppIntegrationOutput

delete(integration_id: str)

Delete Custom OAuth App Integration.

Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.

Parameters:

integration_id – str

get(integration_id: str) → GetCustomAppIntegrationOutput

Get OAuth Custom App Integration.

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

Parameters:

integration_id – str The OAuth app integration ID.

Returns:

GetCustomAppIntegrationOutput

list([, include_creator_username: Optional[bool], page_size: Optional[int], page_token: Optional[str]]) → Iterator[GetCustomAppIntegrationOutput]

Get custom oauth app integrations.

Get the list of custom OAuth app integrations for the specified Databricks account

Parameters:

  • include_creator_username – bool (optional)

  • page_size – int (optional)

  • page_token – str (optional)

Returns:

Iterator over GetCustomAppIntegrationOutput

update(integration_id: str [, redirect_urls: Optional[List[str]], scopes: Optional[List[str]], token_access_policy: Optional[TokenAccessPolicy], user_authorized_scopes: Optional[List[str]]])

Updates Custom OAuth App Integration.

Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.

Parameters:

  • integration_id – str

  • redirect_urls – List[str] (optional) List of OAuth redirect urls to be updated in the custom OAuth app integration

  • scopes – List[str] (optional) List of OAuth scopes to be updated in the custom OAuth app integration, similar to redirect URIs this will fully replace the existing values instead of appending

  • token_access_policy – TokenAccessPolicy (optional) Token access policy to be updated in the custom OAuth app integration

  • user_authorized_scopes – List[str] (optional) Scopes that will need to be consented by end user to mint the access token. If the user does not authorize the access token will not be minted. Must be a subset of scopes.