List groups
https://api.datadoghq.com/api/v2/scim/Groupshttps://api.us3.datadoghq.com/api/v2/scim/Groupshttps://api.us5.datadoghq.com/api/v2/scim/Groupshttps://api.datadoghq.eu/api/v2/scim/Groupshttps://api.ap1.datadoghq.com/api/v2/scim/Groupshttps://api.ap2.datadoghq.com/api/v2/scim/Groupshttps://api.uk1.datadoghq.com/api/v2/scim/Groupshttps://api.ddog-gov.com/api/v2/scim/Groupshttps://api.us2.ddog-gov.com/api/v2/scim/GroupsOverview
List groups in the organization.
Results are paginated by startIndex and count parameters.
Results can be narrowed down by the filter parameter.
Arguments
Query Strings
startIndexSpecifies the start index to fetch the results (1-indexed).
1countSpecifies the number of groups to be returned.
20filterSpecifies the url encoded filter to use to narrow down the results.
Filters can be in the form of displayName eq <group name> or externalId eq <external id of group>
or id eq <group id> and members eq <user uuid> or members eq <user uuid> and id eq <group id>.
Response
OK
List groups response object.
ResourcesList of groups matching the request criteria.
displayNameA human-readable name for the group.
externalIdAn identifier for the resource as defined by the provisioning client.
idThe identifier of the resource. Not required when creating a group.
membersA list of members belonging to the team.
$refThe URI corresponding to a resource that is a member of this group.
displayFull name of the user.
typeA label indicating the type of resource. Only supported value is "User".
valueThe identifier of the member of this group.
metaMetadata associated with a group.
createdThe date and time the group was created.
lastModifiedThe date and time the group was last changed.
locationURL identifying the resource.
resourceTypeType of resource.
schemasGroup JSON Schemas.
itemsPerPageNumber of groups returned per page.
schemasList response JSON Schemas.
startIndexStarting index of the groups for this page (1-indexed).
totalResultsTotal number of groups matching the request criteria.
{
"Resources": [
{
"displayName": "Group 1",
"externalId": "group1",
"id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
"members": [
{
"$ref": "https://app.datadoghq.com/api/scim/v2/Users/d34a5f93-5690-4d3f-a293-f2ad5c7a82a4",
"display": "John Doe",
"type": "User",
"value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4"
},
{
"$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
"display": "Jane Doe",
"type": "User",
"value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
}
],
"meta": {
"created": "2024-11-22T15:05:52.055138963Z",
"lastModified": "2024-11-22T15:05:52.055139017Z",
"location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
},
{
"displayName": "Group 2",
"externalId": "group2",
"id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a",
"members": [
{
"$ref": "https://app.datadoghq.com/api/scim/v2/Users/29da9fb7-8fca-4e87-bf58-86652253deae",
"display": "Alice Smith",
"type": "User",
"value": "29da9fb7-8fca-4e87-bf58-86652253deae"
},
{
"$ref": "https://app.datadoghq.com/api/scim/v2/Users/f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9",
"display": "Bob Smith",
"type": "User",
"value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9"
}
],
"meta": {
"created": "2024-11-22T15:05:52.055139748Z",
"lastModified": "2024-11-22T15:05:52.055139813Z",
"location": "https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
}
],
"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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-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/Groups" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"