user_authorized_clients

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

Overview

Name	user_authorized_clients
Type	Resource
Id	datadog.organization.user_authorized_clients

Fields

The following fields are returned by SELECT queries:

get_user_authorized_client

Name	Datatype	Description
id	string	The unique identifier of the user authorized client. (example: 00000000-0000-0000-0000-000000000001)
attributes	object	Attributes of a user authorized client.
relationships	object	Relationships for a user authorized client.
type	string	The resource type for user authorized clients. (user_authorized_clients) (example: user_authorized_clients)

list_user_authorized_clients

Name	Datatype	Description
id	string	The unique identifier of the user authorized client. (example: 00000000-0000-0000-0000-000000000001)
attributes	object	Attributes of a user authorized client.
relationships	object	Relationships for a user authorized client.
type	string	The resource type for user authorized clients. (user_authorized_clients) (example: user_authorized_clients)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_authorized_client	select	user_authorized_client_id		Get a single OAuth2 client authorization for the current user.
list_user_authorized_clients	select		page[size], page[number], filter, filter[disabled], include	Get a list of all OAuth2 clients authorized by the current user.
delete_user_authorized_client	delete	user_authorized_client_id		Disable the current user's authorization for the specified OAuth2 client.

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.
user_authorized_client_id	string	The ID of the user authorized client.
filter	string	Filter results by client name, app title, or app description.
filter[disabled]	string	Filter results by the user-level disabled status.
include	string	Comma-separated list of related resources to include. Options: oauth2_client, oauth2_client.app.
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.

SELECT examples

get_user_authorized_client

Get a single OAuth2 client authorization for the current user.

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

list_user_authorized_clients

Get a list of all OAuth2 clients authorized by the current user.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.user_authorized_clients
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND filter = '{{ filter }}'
AND filter[disabled] = '{{ filter[disabled] }}'
AND include = '{{ include }}'
;

DELETE examples

delete_user_authorized_client

Disable the current user's authorization for the specified OAuth2 client.

DELETE FROM datadog.organization.user_authorized_clients
WHERE user_authorized_client_id = '{{ user_authorized_client_id }}' --required
;