Skip to main content

org_authorized_client_user_authorized_clients

Creates, updates, deletes, gets or lists an org_authorized_client_user_authorized_clients resource.

Overview

Nameorg_authorized_client_user_authorized_clients
TypeResource
Iddatadog.organization.org_authorized_client_user_authorized_clients

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe unique identifier of the user authorized client. (example: 00000000-0000-0000-0000-000000000001)
attributesobjectAttributes of a user authorized client.
relationshipsobjectRelationships for a user authorized client.
typestringThe resource type for user authorized clients. (user_authorized_clients) (example: user_authorized_clients)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_org_authorized_client_user_authorizationsselectorg_authorized_client_idpage[size], page[number], sort, filter[disabled], filter[user][name], filter[user][email], filter[user][disabled]Get a list of user authorizations for the specified OAuth2 client in the current organization.
delete_org_authorized_client_user_authorizationdeleteorg_authorized_client_id, user_authorized_client_idDisable a specific user authorization for the specified OAuth2 client in the current organization.

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.

NameDatatypeDescription
org_authorized_client_idstringThe ID of the org authorized client.
sitestringThe 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_idstringThe ID of the user authorized client.
filter[disabled]stringFilter results by the user authorization disabled status.
filter[user][disabled]stringFilter results by whether the user is disabled.
filter[user][email]stringFilter results by user email.
filter[user][name]stringFilter results by user name.
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.
sortstringField to sort results by. Options: user.name, user.email, oauth2_client.name.

SELECT examples

Get a list of user authorizations for the specified OAuth2 client in the current organization.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.org_authorized_client_user_authorized_clients
WHERE org_authorized_client_id = '{{ org_authorized_client_id }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND filter[disabled] = '{{ filter[disabled] }}'
AND filter[user][name] = '{{ filter[user][name] }}'
AND filter[user][email] = '{{ filter[user][email] }}'
AND filter[user][disabled] = '{{ filter[user][disabled] }}'
;

DELETE examples

Disable a specific user authorization for the specified OAuth2 client in the current organization.

DELETE FROM datadog.organization.org_authorized_client_user_authorized_clients
WHERE org_authorized_client_id = '{{ org_authorized_client_id }}' --required
AND user_authorized_client_id = '{{ user_authorized_client_id }}' --required
;