published_app_integration

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

Overview

Name	published_app_integration
Type	Resource
Id	databricks_account.oauth2.published_app_integration

Fields

The following fields are returned by SELECT queries:

published_app_integration_get

Name	Datatype	Description
name	string	Display name of the published OAuth app
app_id	string
integration_id	string	Unique integration id for the published OAuth app
create_time	string
created_by	integer
▶token_access_policy	object	Token access policy

published_app_integration_list

Name	Datatype	Description
name	string	Display name of the published OAuth app
app_id	string
integration_id	string	Unique integration id for the published OAuth app
create_time	string
created_by	integer
▶token_access_policy	object	Token access policy

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
published_app_integration_get	select	account_id, integration_id, account_host		Gets the Published OAuth App Integration for the given integration id.
published_app_integration_list	select	account_id, account_host	page_size, page_token	Get the list of published OAuth app integrations for the specified Databricks account
published_app_integration_create	insert	account_id, account_host		Create Published OAuth App Integration.
published_app_integration_update	update	account_id, integration_id, account_host		Updates an existing published OAuth App Integration. You can retrieve the published OAuth app
published_app_integration_delete	delete	account_id, integration_id, account_host		Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app

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
page_size	integer
page_token	string

SELECT examples

published_app_integration_get

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

SELECT
name,
app_id,
integration_id,
create_time,
created_by,
token_access_policy
FROM databricks_account.oauth2.published_app_integration
WHERE account_id = '{{ account_id }}' -- required
AND integration_id = '{{ integration_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

published_app_integration_list

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

SELECT
name,
app_id,
integration_id,
create_time,
created_by,
token_access_policy
FROM databricks_account.oauth2.published_app_integration
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

published_app_integration_create

Create Published OAuth App Integration.

INSERT INTO databricks_account.oauth2.published_app_integration (
app_id,
token_access_policy,
account_id,
account_host
)
SELECT 
'{{ app_id }}',
'{{ token_access_policy }}',
'{{ account_id }}',
'{{ account_host }}'
RETURNING
integration_id
;

Manifest

# Description fields are for documentation purposes
- name: published_app_integration
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the published_app_integration resource.
  - name: account_host
    value: "{{ account_host }}"
    description: Required parameter for the published_app_integration resource.
  - name: app_id
    value: "{{ app_id }}"
    description: |
      App id of the OAuth published app integration. For example power-bi, tableau-deskop
  - 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 }}

UPDATE examples

published_app_integration_update

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

UPDATE databricks_account.oauth2.published_app_integration
SET 
token_access_policy = '{{ token_access_policy }}'
WHERE 
account_id = '{{ account_id }}' --required
AND integration_id = '{{ integration_id }}' --required
AND account_host = '{{ account_host }}' --required;

DELETE examples

published_app_integration_delete

Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app

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