Create user
POST
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
Create a new user.
To assign Datadog roles to the user, include a roles array containing role UUIDs in the value field.
Request
Body Data (required)
Field
Type
Description
activeboolean
A Boolean value indicating the User's administrative status.
emails[object]
Email addresses for the user.
primaryboolean
Boolean indicating if this email is the primary email address.
typeenum
The type of email.
Allowed enum values:
workvaluestring
Email addresses for the user.
idstring
The identifier of the resource. Not required when creating a user.
metaobject
Metadata associated with a user.
createddate-time
The date and time the user was created.
lastModifieddate-time
The date and time the user was last changed.
locationstring
URL identifying the resource.
resourceTypestring
Type of resource.
nameobject
The components of user's real name
formattedstring
The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
roles[object]
Datadog roles assigned to the user. Provide the role UUID in value when provisioning or updating roles through SCIM.
value [required]string
Datadog role UUID.
schemas[string]
User JSON Schemas.
titlestring
The user's title.
userNamestring
Unique identifier for the User.
{
"active": false,
"emails": [
{
"primary": false,
"type": "string",
"value": "string"
}
],
"id": "string",
"meta": {
"created": "2024-10-17 12:53:35.793883+00:00",
"lastModified": "2024-10-19 12:53:35.793883+00:00",
"location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
"resourceType": "User"
},
"name": {
"formatted": "string"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "string",
"userName": "string"
}Response
Created
Definition of a user.
Field
Type
Description
activeboolean
A Boolean value indicating the User's administrative status.
emails[object]
Email addresses for the user.
primaryboolean
Boolean indicating if this email is the primary email address.
typeenum
The type of email.
Allowed enum values:
workvaluestring
Email addresses for the user.
idstring
The identifier of the resource. Not required when creating a user.
metaobject
Metadata associated with a user.
createddate-time
The date and time the user was created.
lastModifieddate-time
The date and time the user was last changed.
locationstring
URL identifying the resource.
resourceTypestring
Type of resource.
nameobject
The components of user's real name
formattedstring
The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
roles[object]
Datadog roles assigned to the user. Provide the role UUID in value when provisioning or updating roles through SCIM.
displaystring
Human-readable Datadog role name returned in responses.
value [required]string
Datadog role UUID.
schemas[string]
User JSON Schemas.
titlestring
The user's title.
userNamestring
Unique identifier for the User.
{
"active": false,
"emails": [
{
"primary": false,
"type": "string",
"value": "string"
}
],
"id": "string",
"meta": {
"created": "2024-10-17 12:53:35.793883+00:00",
"lastModified": "2024-10-19 12:53:35.793883+00:00",
"location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
"resourceType": "User"
},
"name": {
"formatted": "string"
},
"roles": [
{
"display": "Datadog Read Only Role",
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "string",
"userName": "string"
}Bad Request
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
Create user
## default
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF
## json-request-body
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"active": true,
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@datadoghq.com"
}
],
"name": {
"formatted": "John Doe"
},
"roles": [
{
"value": "00000000-0000-0000-0000-000000000001"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"title": "Mr.",
"userName": "john.doe@datadoghq.com"
}
EOF