custom_app_integrations
Creates, updates, deletes, gets or lists a custom_app_integrations
resource.
Overview
Name | custom_app_integrations |
Type | Resource |
Id | databricks_account.oauth.custom_app_integrations |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Request completed successfully.
Name | Datatype | Description |
---|---|---|
name | string | |
client_id | string | |
integration_id | string | |
confidential | boolean | |
create_time | string | |
created_by | integer | |
creator_username | string | |
redirect_urls | array | |
scopes | array | |
token_access_policy | object |
Request completed successfully.
Name | Datatype | Description |
---|---|---|
name | string | |
client_id | string | |
integration_id | string | |
confidential | boolean | |
create_time | string | |
created_by | integer | |
creator_username | string | |
redirect_urls | array | |
scopes | array | |
token_access_policy | object |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | Gets the Custom OAuth App Integration for the given integration id. | ||
list | select | Get the list of custom OAuth app integrations for the specified Databricks account | ||
create | insert | Create Custom OAuth App Integration. | ||
update | update | Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via | ||
delete | delete | 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 |
---|
SELECT
examples
- get
- list
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
FROM databricks_account.oauth.custom_app_integrations;
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
FROM databricks_account.oauth.custom_app_integrations;
INSERT
examples
- create
- Manifest
Create Custom OAuth App Integration.
INSERT INTO databricks_account.oauth.custom_app_integrations (
data__redirect_urls,
data__name,
data__confidential,
data__scopes,
data__token_access_policy
)
SELECT
'{{ redirect_urls }}',
'{{ name }}',
{{ confidential }},
'{{ scopes }}',
'{{ token_access_policy }}'
RETURNING
client_id,
integration_id,
client_secret
;
# Description fields are for documentation purposes
- name: custom_app_integrations
props:
- name: redirect_urls
value: Array of string
- name: name
value: string
- name: confidential
value: boolean
- name: scopes
value: Array of string
- name: token_access_policy
value: object
UPDATE
examples
- update
Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via
UPDATE databricks_account.oauth.custom_app_integrations
SET
data__redirect_urls = '{{ redirect_urls }}',
data__token_access_policy = '{{ token_access_policy }}'
WHERE
;
DELETE
examples
- delete
Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via
DELETE FROM databricks_account.oauth.custom_app_integrations;