token_management

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

Overview

Name	token_management
Type	Resource
Id	databricks_workspace.settings.token_management

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶token_info	object

list

Name	Datatype	Description
created_by_id	integer	User ID of the user that created the token.
owner_id	integer	User ID of the user that owns the token.
token_id	string	ID of the token.
workspace_id	integer	If applicable, the ID of the workspace that the token was created in.
autoscope_state	string
backfill_scopes	array	Output only. Scopes inferred from offline backfill processing.
comment	string	Comment that describes the purpose of the token, specified by the token creator.
created_by_username	string	Username of the user that created the token.
creation_time	integer	Timestamp when the token was created.
expiry_time	integer	Timestamp when the token expires.
inferred_scopes	array	Output only. Inferred API path scopes collected for this token when autoscope is enabled.
last_used_day	integer	Approximate timestamp for the day the token was last used. Accurate up to 1 day.
scopes	array	Scope of the token was created with, if applicable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	token_id, deployment_name		Gets information about a token, specified by its ID.
list	select	deployment_name	created_by_id, created_by_username	Lists all tokens associated with the specified workspace or user.
create	insert	deployment_name, application_id		Creates a token on behalf of a service principal.
token_management_update_token_management	update	token_id, deployment_name, token, update_mask		Updates a token, specified by its ID.
delete	delete	token_id, deployment_name		Deletes a token, specified by its ID.

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
token_id	string	The ID of the token to revoke.
created_by_id	integer	User ID of the user that created the token.
created_by_username	string	Username of the user that created the token.

SELECT examples

get

Gets information about a token, specified by its ID.

SELECT
token_info
FROM databricks_workspace.settings.token_management
WHERE token_id = '{{ token_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists all tokens associated with the specified workspace or user.

SELECT
created_by_id,
owner_id,
token_id,
workspace_id,
autoscope_state,
backfill_scopes,
comment,
created_by_username,
creation_time,
expiry_time,
inferred_scopes,
last_used_day,
scopes
FROM databricks_workspace.settings.token_management
WHERE deployment_name = '{{ deployment_name }}' -- required
AND created_by_id = '{{ created_by_id }}'
AND created_by_username = '{{ created_by_username }}'
;

INSERT examples

create

Creates a token on behalf of a service principal.

INSERT INTO databricks_workspace.settings.token_management (
application_id,
autoscope_enabled,
comment,
lifetime_seconds,
scopes,
deployment_name
)
SELECT 
'{{ application_id }}' /* required */,
{{ autoscope_enabled }},
'{{ comment }}',
{{ lifetime_seconds }},
'{{ scopes }}',
'{{ deployment_name }}'
RETURNING
token_info,
token_value
;

Manifest

# Description fields are for documentation purposes
- name: token_management
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the token_management resource.
  - name: application_id
    value: "{{ application_id }}"
    description: |
      Application ID of the service principal.
  - name: autoscope_enabled
    value: {{ autoscope_enabled }}
    description: |
      Whether to enable autoscoping for this token.
  - name: comment
    value: "{{ comment }}"
    description: |
      Comment that describes the purpose of the token.
  - name: lifetime_seconds
    value: {{ lifetime_seconds }}
    description: |
      The number of seconds before the token expires.
  - name: scopes
    value:
      - "{{ scopes }}"

UPDATE examples

token_management_update_token_management

Updates a token, specified by its ID.

UPDATE databricks_workspace.settings.token_management
SET 
token = '{{ token }}',
update_mask = '{{ update_mask }}'
WHERE 
token_id = '{{ token_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND token = '{{ token }}' --required
AND update_mask = '{{ update_mask }}' --required
RETURNING
created_by_id,
owner_id,
token_id,
workspace_id,
autoscope_state,
backfill_scopes,
comment,
created_by_username,
creation_time,
expiry_time,
inferred_scopes,
last_used_day,
scopes;

DELETE examples

delete

Deletes a token, specified by its ID.

DELETE FROM databricks_workspace.settings.token_management
WHERE token_id = '{{ token_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;