List users
https://api.datadoghq.com/api/v2/scim/Usershttps://api.us3.datadoghq.com/api/v2/scim/Usershttps://api.us5.datadoghq.com/api/v2/scim/Usershttps://api.datadoghq.eu/api/v2/scim/Usershttps://api.ap1.datadoghq.com/api/v2/scim/Usershttps://api.ap2.datadoghq.com/api/v2/scim/Usershttps://api.uk1.datadoghq.com/api/v2/scim/Usershttps://api.ddog-gov.com/api/v2/scim/Usershttps://api.us2.ddog-gov.com/api/v2/scim/UsersOverview
List users in the organization.
Results are paginated by startIndex and count parameters.
Results can be narrowed down by the filter parameter.
Responses include the Datadog roles assigned to each user in the roles attribute.
Arguments
Query Strings
startIndexSpecifies the start index to fetch the results (1-indexed).
1countSpecifies the number of users to be returned.
20filterSpecifies the url encoded filter to use to narrow down the results.
Filter should be of the form userName eq <user name>.
Response
OK
List users response object.
ResourcesList of users matching the request criteria.
activeA Boolean value indicating the User's administrative status.
emailsEmail addresses for the user.
primaryBoolean indicating if this email is the primary email address.
typeThe type of email.
workvalueEmail addresses for the user.
idThe identifier of the resource. Not required when creating a user.
metaMetadata associated with a user.
createdThe date and time the user was created.
lastModifiedThe date and time the user was last changed.
locationURL identifying the resource.
resourceTypeType of resource.
nameThe components of user's real name
formattedThe full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
rolesDatadog roles assigned to the user. Provide the role UUID in value when provisioning or updating roles through SCIM.
displayHuman-readable Datadog role name returned in responses.
value [required]Datadog role UUID.
schemasUser JSON Schemas.
titleThe user's title.
userNameUnique identifier for the User.
itemsPerPageNumber of users returned per page.
schemasList response JSON Schemas.
startIndexStarting index of the users for this page (1-indexed).
totalResultsTotal number of users matching the request criteria.
{
"Resources": [
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
"meta": {
"created": "2024-11-22T15:05:52.055138963Z",
"lastModified": "2024-11-22T15:05:52.055139017Z",
"location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
"resourceType": "User"
},
"name": {
"formatted": "John Doe"
},
"roles": [
{
"display": "Datadog Read Only Role",
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
},
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "jane.doe@datadoghq.com"
}
],
"id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a",
"meta": {
"created": "2024-11-22T15:05:52.055139748Z",
"lastModified": "2024-11-22T15:05:52.055139813Z",
"location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a",
"resourceType": "User"
},
"name": {
"formatted": "Jane Doe"
},
"roles": [
{
"display": "Datadog Standard Role",
"value": "00000000-0000-0000-0000-000000000002"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mrs.",
"userName": "jane.doe@datadoghq.com"
}
],
"itemsPerPage": 2,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 1,
"totalResults": 2
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"