custom_app_integrations

Operations on a custom_app_integrations resource.

Overview

Name	custom_app_integrations
Type	Resource
Id	databricks_account.oauth.custom_app_integrations

Fields

Name	Datatype
name	string
client_id	string
confidential	boolean
create_time	string
created_by	integer
creator_username	string
integration_id	string
redirect_urls	array
scopes	array
token_access_policy	object

Methods

Name	Accessible by	Required Params	Description
get	SELECT	account_id, integration_id	Gets the Custom OAuth App Integration for the given integration id.
list	SELECT	account_id	Get the list of custom OAuth app integrations for the specified Databricks account
create	INSERT	account_id	Create Custom OAuth App Integration.
delete	DELETE	account_id, integration_id	Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via
update	UPDATE	account_id, integration_id	Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via

SELECT examples

custom_app_integrations (list)

SELECT
name,
client_id,
confidential,
create_time,
created_by,
creator_username,
integration_id,
redirect_urls,
scopes,
token_access_policy
FROM databricks_account.oauth.custom_app_integrations
WHERE account_id = '{{ account_id }}';

custom_app_integrations (get)

SELECT
name,
client_id,
confidential,
create_time,
created_by,
creator_username,
integration_id,
redirect_urls,
scopes,
token_access_policy
FROM databricks_account.oauth.custom_app_integrations
WHERE account_id = '{{ account_id }}' AND
integration_id = '{{ integration_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new custom_app_integrations resource.

custom_app_integrations

/*+ create */
INSERT INTO databricks_account.oauth.custom_app_integrations (
account_id,
data__summary,
data__value
)
SELECT 
'{{ account_id }}',
'{{ summary }}',
'{{ value }}'
;

Manifest

- name: your_resource_model_name
  props:
  - name: summary
    value: Create Tableau Cloud OAuth App Integration
  - name: value
    value:
      name: Example Tableau Server
      scopes:
      - all-apis
      - offline_access
      token_access_policy:
        access_token_ttl_in_minutes: 120
        refresh_token_ttl_in_minutes: 200
      redirect_urls:
      - https://example.online.tableau.com/auth/add_oauth_token
      confidential: true

UPDATE example

Updates a custom_app_integrations resource.

/*+ update */
-- replace field1, field2, etc. with the fields you want to update        
UPDATE databricks_account.oauth.custom_app_integrations
SET field1 = '{{ value1 }}',
field2 = '{{ value2 }}', ...
WHERE account_id = '{{ account_id }}' AND
integration_id = '{{ integration_id }}';

DELETE example

Deletes a custom_app_integrations resource.

/*+ delete */
DELETE FROM databricks_account.oauth.custom_app_integrations
WHERE account_id = '{{ account_id }}' AND
integration_id = '{{ integration_id }}';