GET https://api.ap1.datadoghq.com/api/v2/org_authorized_clientshttps://api.ap2.datadoghq.com/api/v2/org_authorized_clientshttps://api.datadoghq.eu/api/v2/org_authorized_clientshttps://api.ddog-gov.com/api/v2/org_authorized_clientshttps://api.us2.ddog-gov.com/api/v2/org_authorized_clientshttps://api.uk1.datadoghq.com/api/v2/org_authorized_clientshttps://api.datadoghq.com/api/v2/org_authorized_clientshttps://api.us3.datadoghq.com/api/v2/org_authorized_clientshttps://api.us5.datadoghq.com/api/v2/org_authorized_clients
Overview
Get a list of all OAuth2 clients authorized for the current organization.
This endpoint requires
any
of the following permissions:
org_authorized_apps_readmanage_integrationsOAuth apps require the org_authorized_apps_read authorization scope to access this endpoint.
Arguments
Query Strings
Size for a given page. The maximum allowed value is 100.
Specific page number to return.
Field to sort results by. Options include oauth2_client.name.
Filter results by client name, app title, or app description.
filter[oauth2_client][name]
Filter results by the OAuth2 client name.
Filter results by the org-level disabled status.
Comma-separated list of related resources to include.
Options: oauth2_client, oauth2_client.app, user_authorized_clients.user.
Response
OK
Response containing a list of org authorized clients.
Expand All
List of org authorized client data objects.
Attributes of an org authorized client.
Whether the organization has disabled this client.
last_exercised [required]
The date and time this client was last exercised.
The number of users in the organization who have authorized this client.
The unique identifier of the org authorized client.
Relationships for an org authorized client.
Relationship to the OAuth2 client for this org authorized client.
Data identifying the OAuth2 client associated with this org authorized client.
The ID of the OAuth2 client.
OAuth2 client resource type.
Allowed enum values: oauth2_clients
user_authorized_clients [required]
Relationship to the user authorized clients for this org authorized client.
List of user authorized client relationship data objects.
The ID of the user authorized client.
User authorized client resource type.
Allowed enum values: user_authorized_clients
Links for the user authorized clients relationship.
Link to the user authorized clients for this org authorized client.
The resource type for org authorized clients.
Allowed enum values: org_authorized_clients
Object describing meta attributes of response.
Total count of elements matched by the filter.
{
"data": [
{
"attributes": {
"disabled": false,
"last_exercised": "2024-01-15T10:30:00+00:00",
"user_count": 2
},
"id": "00000000-0000-0000-0000-000000000001",
"relationships": {
"oauth2_client": {
"data": {
"id": "00000000-0000-0000-0000-000000000010",
"type": "oauth2_clients"
}
},
"user_authorized_clients": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000020",
"type": "user_authorized_clients"
}
],
"links": {
"related": "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients"
}
}
},
"type": "org_authorized_clients"
}
],
"meta": {
"page": {
"total_count": "integer",
"total_filtered_count": "integer"
}
}
}
Authentication error
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_authorized_clients" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
