personal_access_tokens

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

Overview

Name	personal_access_tokens
Type	Resource
Id	datadog.organization.personal_access_tokens

Fields

The following fields are returned by SELECT queries:

get_personal_access_token

Name	Datatype	Description
id	string	ID of the access token.
attributes	object	Attributes of an access token.
relationships	object	Resources related to the access token.
type	string	Personal access tokens resource type. (personal_access_tokens) (default: personal_access_tokens, example: personal_access_tokens)

list_personal_access_tokens

Name	Datatype	Description
id	string	ID of the access token.
attributes	object	Attributes of an access token.
relationships	object	Resources related to the access token entry in the mixed list response.
type	string	Resource type returned by the access tokens list endpoint. Includes both personal and service access tokens. (personal_access_tokens, service_access_tokens) (example: personal_access_tokens)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_personal_access_token	select	token_id		Get a specific personal access token by its ID.
list_personal_access_tokens	select		page[size], page[number], sort, filter, filter[owned_by]	List all access tokens for the organization.
create_personal_access_token	insert	data		Create a personal access token for the current user.
update_personal_access_token	update	token_id, data		Update a specific personal access token.
revoke_personal_access_token	delete	token_id		Revoke a specific personal access token.

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
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
token_id	string	The ID of the access token.
filter	string	Filter access tokens by the specified string.
filter[owned_by]	array	Filter access tokens by the owner's ID. Supports multiple values.
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.
sort	string	Access token attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

SELECT examples

get_personal_access_token

Get a specific personal access token by its ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.personal_access_tokens
WHERE token_id = '{{ token_id }}' -- required
;

list_personal_access_tokens

List all access tokens for the organization.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.personal_access_tokens
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND filter = '{{ filter }}'
AND filter[owned_by] = '{{ filter[owned_by] }}'
;

INSERT examples

create_personal_access_token

Create a personal access token for the current user.

INSERT INTO datadog.organization.personal_access_tokens (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: personal_access_tokens
props:
  - name: data
    description: |
      Object used to create an access token.
    value:
      attributes:
        expires_at: "{{ expires_at }}"
        name: "{{ name }}"
        scopes:
          - "{{ scopes }}"
      type: "{{ type }}"

UPDATE examples

update_personal_access_token

Update a specific personal access token.

UPDATE datadog.organization.personal_access_tokens
SET 
data = '{{ data }}'
WHERE 
token_id = '{{ token_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

revoke_personal_access_token

Revoke a specific personal access token.

DELETE FROM datadog.organization.personal_access_tokens
WHERE token_id = '{{ token_id }}' --required
;