org_authorized_client_user_authorized_clients
Creates, updates, deletes, gets or lists an org_authorized_client_user_authorized_clients resource.
Overview
| Name | org_authorized_client_user_authorized_clients |
| Type | Resource |
| Id | datadog.organization.org_authorized_client_user_authorized_clients |
Fields
The following fields are returned by SELECT queries:
- list_org_authorized_client_user_authorizations
| 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 |
|---|---|---|---|---|
list_org_authorized_client_user_authorizations | select | org_authorized_client_id | page[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_authorization | delete | org_authorized_client_id, user_authorized_client_id | Disable 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.
| Name | Datatype | Description |
|---|---|---|
org_authorized_client_id | string | The ID of the org authorized client. |
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[disabled] | string | Filter results by the user authorization disabled status. |
filter[user][disabled] | string | Filter results by whether the user is disabled. |
filter[user][email] | string | Filter results by user email. |
filter[user][name] | string | Filter 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. |
sort | string | Field to sort results by. Options: user.name, user.email, oauth2_client.name. |
SELECT examples
- list_org_authorized_client_user_authorizations
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
- delete_org_authorized_client_user_authorization
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
;