service_account_access_tokens

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

Overview

Name	service_account_access_tokens
Type	Resource
Id	datadog.organization.service_account_access_tokens

Fields

The following fields are returned by SELECT queries:

get_service_account_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	Service access tokens resource type. (service_access_tokens) (default: service_access_tokens, example: service_access_tokens)

list_service_account_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.
type	string	Service access tokens resource type. (service_access_tokens) (default: service_access_tokens, example: service_access_tokens)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_account_access_token	select	service_account_id, token_id		Get a specific access token for a service account by its ID.
list_service_account_access_tokens	select	service_account_id	page[size], page[number], sort, filter	List all access tokens for a specific service account.
create_service_account_access_token	insert	service_account_id, data		Create an access token for a service account.
update_service_account_access_token	update	service_account_id, token_id, data		Update a specific access token for a service account.
revoke_service_account_access_token	delete	service_account_id, token_id		Revoke a specific access token for a service account.

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
service_account_id	string	The ID of the service account.
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.
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_service_account_access_token

Get a specific access token for a service account by its ID.

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

list_service_account_access_tokens

List all access tokens for a specific service account.

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

INSERT examples

create_service_account_access_token

Create an access token for a service account.

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

Manifest

# Description fields are for documentation purposes
- name: service_account_access_tokens
props:
  - name: service_account_id
    value: "{{ service_account_id }}"
    description: Required parameter for the service_account_access_tokens resource.
  - name: data
    description: |
      Object used to create a service account access token.
    value:
      attributes:
        expires_at: "{{ expires_at }}"
        name: "{{ name }}"
        scopes:
          - "{{ scopes }}"
      type: "{{ type }}"

UPDATE examples

update_service_account_access_token

Update a specific access token for a service account.

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

DELETE examples

revoke_service_account_access_token

Revoke a specific access token for a service account.

DELETE FROM datadog.organization.service_account_access_tokens
WHERE service_account_id = '{{ service_account_id }}' --required
AND token_id = '{{ token_id }}' --required
;