service_account_keys

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

Overview

Name	service_account_keys
Type	Resource
Id	datadog.organization.service_account_keys

Fields

The following fields are returned by SELECT queries:

get_service_account_application_key

Name	Datatype	Description
id	string	ID of the application key.
attributes	object	Attributes of a partial application key.
relationships	object	Resources related to the application key.
type	string	Application Keys resource type. (application_keys) (default: application_keys, example: application_keys)

list_service_account_application_keys

Name	Datatype	Description
id	string	ID of the application key.
attributes	object	Attributes of a partial application key.
relationships	object	Resources related to the application key.
type	string	Application Keys resource type. (application_keys) (default: application_keys, example: application_keys)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_account_application_key	select	service_account_id, app_key_id		Get an application key owned by this service account.
list_service_account_application_keys	select	service_account_id	page[size], page[number], sort, filter, filter[created_at][start], filter[created_at][end]	List all application keys available for this service account.
create_service_account_application_key	insert	service_account_id, data		Create an application key for this service account.
update_service_account_application_key	update	service_account_id, app_key_id, data		Edit an application key owned by this service account.
delete_service_account_application_key	delete	service_account_id, app_key_id		Delete an application key owned by this 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
app_key_id	string	The ID of the application key.
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.
filter	string	Filter application keys by the specified string.
filter[created_at][end]	string	Only include application keys created on or before the specified date.
filter[created_at][start]	string	Only include application keys created on or after the specified date.
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	Application key 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_application_key

Get an application key owned by this service account.

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

list_service_account_application_keys

List all application keys available for this service account.

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

INSERT examples

create_service_account_application_key

Create an application key for this service account.

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

Manifest

# Description fields are for documentation purposes
- name: service_account_keys
props:
  - name: service_account_id
    value: "{{ service_account_id }}"
    description: Required parameter for the service_account_keys resource.
  - name: data
    description: |
      Object used to create an application key.
    value:
      attributes:
        name: "{{ name }}"
        scopes:
          - "{{ scopes }}"
      type: "{{ type }}"

UPDATE examples

update_service_account_application_key

Edit an application key owned by this service account.

UPDATE datadog.organization.service_account_keys
SET 
data = '{{ data }}'
WHERE 
service_account_id = '{{ service_account_id }}' --required
AND app_key_id = '{{ app_key_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_service_account_application_key

Delete an application key owned by this service account.

DELETE FROM datadog.organization.service_account_keys
WHERE service_account_id = '{{ service_account_id }}' --required
AND app_key_id = '{{ app_key_id }}' --required
;