custom_app_integration

Creates, updates, deletes, gets or lists a custom_app_integration resource.

Overview

Name	custom_app_integration
Type	Resource
Id	databricks_account.oauth2.custom_app_integration

Fields

The following fields are returned by SELECT queries:

custom_app_integration_get

Name	Datatype	Description
name	string	The display name of the custom OAuth app
client_id	string
integration_id	string	ID of this custom app
confidential	boolean	This field indicates whether an OAuth client secret is required to authenticate this client.
create_time	string
created_by	integer
creator_username	string
redirect_urls	array	List of OAuth redirect urls
scopes	array
▶token_access_policy	object	Token access policy
user_authorized_scopes	array	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.

custom_app_integration_list

Name	Datatype	Description
name	string	The display name of the custom OAuth app
client_id	string
integration_id	string	ID of this custom app
confidential	boolean	This field indicates whether an OAuth client secret is required to authenticate this client.
create_time	string
created_by	integer
creator_username	string
redirect_urls	array	List of OAuth redirect urls
scopes	array
▶token_access_policy	object	Token access policy
user_authorized_scopes	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
custom_app_integration_get	select	account_id, integration_id, account_host		Gets the Custom OAuth App Integration for the given integration id.
custom_app_integration_list	select	account_id, account_host	include_creator_username, page_size, page_token	Get the list of custom OAuth app integrations for the specified Databricks account
custom_app_integration_create	insert	account_id, account_host		Create Custom OAuth App Integration.
custom_app_integration_update	update	account_id, integration_id, account_host		Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration
custom_app_integration_delete	delete	account_id, integration_id, account_host		Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string
integration_id	string
include_creator_username	boolean
page_size	integer
page_token	string

SELECT examples

custom_app_integration_get

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

SELECT
name,
client_id,
integration_id,
confidential,
create_time,
created_by,
creator_username,
redirect_urls,
scopes,
token_access_policy,
user_authorized_scopes
FROM databricks_account.oauth2.custom_app_integration
WHERE account_id = '{{ account_id }}' -- required
AND integration_id = '{{ integration_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

custom_app_integration_list

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

SELECT
name,
client_id,
integration_id,
confidential,
create_time,
created_by,
creator_username,
redirect_urls,
scopes,
token_access_policy,
user_authorized_scopes
FROM databricks_account.oauth2.custom_app_integration
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND include_creator_username = '{{ include_creator_username }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

custom_app_integration_create

Create Custom OAuth App Integration.

INSERT INTO databricks_account.oauth2.custom_app_integration (
confidential,
name,
redirect_urls,
scopes,
token_access_policy,
user_authorized_scopes,
account_id,
account_host
)
SELECT 
{{ confidential }},
'{{ name }}',
'{{ redirect_urls }}',
'{{ scopes }}',
'{{ token_access_policy }}',
'{{ user_authorized_scopes }}',
'{{ account_id }}',
'{{ account_host }}'
RETURNING
client_id,
integration_id,
client_secret
;

Manifest

# Description fields are for documentation purposes
- name: custom_app_integration
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the custom_app_integration resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the custom_app_integration resource.
  - name: confidential
    value: {{ confidential }}
    description: |
      This field indicates whether an OAuth client secret is required to authenticate this client.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the custom OAuth app
  - name: redirect_urls
    value:
      - "{{ redirect_urls }}"
    description: |
      List of OAuth redirect urls
  - name: scopes
    value:
      - "{{ scopes }}"
    description: |
      OAuth scopes granted to the application. Supported scopes: all-apis, sql, offline_access, openid, profile, email.
  - name: token_access_policy
    description: |
      Token access policy
    value:
      absolute_session_lifetime_in_minutes: {{ absolute_session_lifetime_in_minutes }}
      access_token_ttl_in_minutes: {{ access_token_ttl_in_minutes }}
      enable_single_use_refresh_tokens: {{ enable_single_use_refresh_tokens }}
      refresh_token_ttl_in_minutes: {{ refresh_token_ttl_in_minutes }}
  - name: user_authorized_scopes
    value:
      - "{{ user_authorized_scopes }}"
    description: |
      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.

UPDATE examples

custom_app_integration_update

Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration

UPDATE databricks_account.oauth2.custom_app_integration
SET 
redirect_urls = '{{ redirect_urls }}',
scopes = '{{ scopes }}',
token_access_policy = '{{ token_access_policy }}',
user_authorized_scopes = '{{ user_authorized_scopes }}'
WHERE 
account_id = '{{ account_id }}' --required
AND integration_id = '{{ integration_id }}' --required
AND account_host = '{{ account_host }}' --required;

DELETE examples

custom_app_integration_delete

Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via

DELETE FROM databricks_account.oauth2.custom_app_integration
WHERE account_id = '{{ account_id }}' --required
AND integration_id = '{{ integration_id }}' --required
AND account_host = '{{ account_host }}' --required
;