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(name: str, redirect_urls: List[str] [, confidential: Optional[bool], scopes: Optional[List[str]], token_access_policy: Optional[TokenAccessPolicy]]) → CreateCustomAppIntegrationOutput

Create Custom OAuth App Integration.

Create Custom OAuth App Integration.

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

Parameters:

  • name – str name of the custom oauth app

  • redirect_urls – List[str] List of oauth redirect urls

  • confidential – bool (optional) indicates if an oauth client-secret should be generated

  • 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

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 The oauth app integration ID.

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() → Iterator[GetCustomAppIntegrationOutput]

Get custom oauth app integrations.

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

Returns:

Iterator over GetCustomAppIntegrationOutput

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

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 The oauth app integration ID.

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

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