Datadog Users API
Create, edit, and disable users.
Datadog Users API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes 28 operations across 16 paths, and defines 138 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
28 operations
16 paths
138 schemas
5 DELETE14 GET3 PATCH5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Datadog Users API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes.
An API key is passed in the header as DD-API-KEY (apiKeyAuth).
An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
AuthZ— This API uses OAuth 2 with the implicit grant flow.apiKeyAuth— Your Datadog API Key.appKeyAuth— Your Datadog APP Key.
Paths & Operations 28
Across 16 paths, the API surfaces 28 operations — 5 DELETE, 14 GET, 3 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Users 28
Create, edit, and disable users.
GET
/api/v2/current_user/application_keys
Datadog Get All Application Keys Owned by Current User
POST
/api/v2/current_user/application_keys
Datadog Create an Application Key for Current User
DELETE
/api/v2/current_user/application_keys/{app_key_id}
Datadog Delete an Application Key Owned by Current User
GET
/api/v2/current_user/application_keys/{app_key_id}
Datadog Get One Application Key Owned by Current User
PATCH
/api/v2/current_user/application_keys/{app_key_id}
Datadog Edit an Application Key Owned by Current User
GET
/api/v2/logs/config/restriction_queries/user/{user_id}
Datadog Get All Restriction Queries for a Given User
GET
/api/v2/on-call/schedules/{schedule_id}/on-call
Datadog Get the Schedule On-call User
GET
/api/v2/on-call/teams/{team_id}/on-call
Datadog Get Team On-call Users
DELETE
/api/v2/roles/{role_id}/users
Datadog Remove a User from a Role
GET
/api/v2/roles/{role_id}/users
Datadog Get All Users of a Role
POST
/api/v2/roles/{role_id}/users
Datadog Add a User to a Role
GET
/api/v2/scim/Users
Datadog List Users
POST
/api/v2/scim/Users
Datadog Create User
DELETE
/api/v2/scim/Users/{user_uuid}
Datadog Delete User
GET
/api/v2/scim/Users/{user_uuid}
Datadog Get User
PATCH
/api/v2/scim/Users/{user_uuid}
Datadog Patch User
PUT
/api/v2/scim/Users/{user_uuid}
Datadog Update User
POST
/api/v2/team/{team_id}/memberships
Datadog Add a User to a Team
DELETE
/api/v2/team/{team_id}/memberships/{user_id}
Datadog Remove a User from a Team
GET
/api/v2/user_invitations/{user_invitation_uuid}
Datadog Get a User Invitation
GET
/api/v2/users
Datadog List All Users
POST
/api/v2/users
Datadog Create a User
DELETE
/api/v2/users/{user_id}
Datadog Disable a User
GET
/api/v2/users/{user_id}
Datadog Get User Details
PATCH
/api/v2/users/{user_id}
Datadog Update a User
GET
/api/v2/users/{user_id}/orgs
Datadog Get a User Organization
GET
/api/v2/users/{user_id}/permissions
Datadog Get a User Permissions
GET
/api/v2/users/{user_uuid}/memberships
Datadog Get User Memberships
Schemas 138
The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are TeamAttributes (12 properties), UserAttributes (12 properties), OrganizationAttributes (8 properties), ExternalUser (8 properties). Each schema is shown below with its type and property counts.
RestrictionQueryWithoutRelationships
object
Restriction query object returned by the API.
3 properties
UsersType
string
Users resource type.
UserTeamRelationships
object
Relationship between membership and a user
2 properties
TeamOnCallRespondersDataRelationships
object
Relationship objects linked to a team's on-call responder configuration, including escalations and responders.
2 properties
RestrictionQueryAttributes
object
Attributes of the restriction query.
3 properties
LeakedKeyAttributes
object
The definition of LeakedKeyAttributes object.
2 properties
1 required
RelationshipToUserTeamPermission
object
Relationship between a user team permission and a team
2 properties
OrganizationAttributes
object
Attributes of the organization.
8 properties
UserAttributes
object
Attributes of user object returned by the API.
12 properties
PermissionAttributes
object
Attributes of a permission.
7 properties
RelationshipToTeamLinks
object
Relationship between a team and a team link
2 properties
UserUpdateRequest
object
Update a user.
1 property
1 required
UserInvitationsType
string
User invitations type.
UserAttributesStatus
string
The user's status.
UserResponseIncludedItem
An object related to a user.
ListApplicationKeysResponse
object
Response for a list of application keys.
3 properties
UserRelationships
object
Relationships of the user object.
1 property
ListExternalUsersResponseResourcesItems
object
Resources returned in response to a List users request.
8 properties
ListExternalUsersResponse
object
List users response object.
5 properties
RoleAttributes
object
Attributes of the role.
4 properties
FullApplicationKey
object
Datadog application key.
4 properties
ApplicationKeyUpdateAttributes
object
Attributes used to update an application Key.
2 properties
TeamOnCallRespondersDataRelationshipsRespondersDataItems
object
Represents a user responder associated with the on-call team.
2 properties
2 required
User
object
User object returned by the API.
4 properties
TeamsResponseMeta
object
Teams response metadata.
1 property
RelationshipToUser
object
Relationship to user.
1 property
1 required
UserTeamPermissionType
string
User team permission type
UserTeamRole
string
The user's role within the team
EscalationRelationships
object
Contains the relationships of an escalation object, including its responders.
1 property
TeamOnCallRespondersDataRelationshipsResponders
object
Defines the list of users assigned as on-call responders for the team.
1 property
RelationshipToOrganization
object
Relationship to an organization.
1 property
1 required
RelationshipToPermissionData
object
Relationship to permission object.
2 properties
TeamRelationships
object
Resources related to a team
2 properties
ApplicationKeyResponseIncludedItem
An object related to an application key.
RelationshipToUserData
object
Relationship to user object.
2 properties
2 required
ShiftDataRelationships
object
The definition of ShiftDataRelationships object.
1 property
ExternalUserPatchRequestOperationsItemsOp
string
The operation to be performed.
EscalationRelationshipsRespondersDataItemsType
string
Represents the resource type for users assigned as responders in an escalation step.
ShiftDataAttributes
object
The definition of ShiftDataAttributes object.
2 properties
EmailTypeType
string
The type of email.
UsersResponse
object
Response containing information about multiple users.
3 properties
ShiftDataType
string
Indicates that the resource is of type 'shifts'.
RelationshipToUserTeamTeamData
object
The team associated with the membership
2 properties
2 required
ShiftDataRelationshipsUserData
object
Represents a reference to the user assigned to this shift, containing the user's ID and resource type.
2 properties
2 required
ApplicationKeyResponse
object
Response for retrieving an application key.
2 properties
UserTeamType
string
Team membership type
TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType
string
Identifies the resource type for escalation policy steps linked to a team's on-call configuration.
ApplicationKeyCreateData
object
Object used to create an application key.
2 properties
2 required
ScheduleUser
object
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
3 properties
1 required
FullApplicationKeyAttributes
object
Attributes of a full application key.
5 properties
TeamType
string
Team type
EscalationRelationshipsRespondersDataItems
object
Represents a user assigned to an escalation step.
2 properties
2 required
UserTeamRequest
object
Team membership request
1 property
1 required
ShiftIncluded
The definition of ShiftIncluded object.
Permission
object
Permission object.
3 properties
1 required
TeamOnCallResponders
object
Root object representing a team's on-call responder configuration.
2 properties
OrganizationsType
string
Organizations resource type.
UserTeamAttributes
object
Team membership attributes
3 properties
UserInvitationResponseData
object
Object of a user invitation returned by the API.
4 properties
ApplicationKeyRelationships
object
Resources related to the application key.
1 property
LeakedKey
object
The definition of LeakedKey object.
3 properties
3 required
UserCreateAttributes
object
Attributes of the created user.
3 properties
1 required
ApplicationKeysType
string
Application Keys resource type.
TeamOnCallRespondersDataRelationshipsEscalationsDataItems
object
Represents a link to a specific escalation policy step associated with the on-call team.
2 properties
2 required
TeamsResponseLinks
object
Teams response links.
5 properties
QuerySortOrder
string
Direction of sort.
UserTeam
object
A user's relationship with a team
4 properties
2 required
ApplicationKeyCreateAttributes
object
Attributes used to create an application Key.
2 properties
1 required
ShiftData
object
The definition of ShiftData object.
4 properties
1 required
RelationshipToUserTeamPermissionData
object
Related user team permission data
2 properties
2 required
ScheduleUserType
string
Users resource type.
UserResponse
object
Response containing information about a single user.
2 properties
UserUpdateData
object
Object to update a user.
3 properties
3 required
APIErrorResponse
object
API error response.
1 property
1 required
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
TeamOnCallRespondersDataRelationshipsRespondersDataItemsType
string
Identifies the resource type for individual user entities associated with on-call response.
ExternalUserNameType
object
The components of user's real name
1 property
RelationshipToUserTeamTeam
object
Relationship between team membership and team
1 property
1 required
UserTeamResponse
object
Team membership response
2 properties
UserInvitationResponse
object
User invitation as returned by the API.
1 property
Shift
object
The definition of Shift object.
2 properties
ApplicationKeyCreateRequest
object
Request used to create an application key.
1 property
1 required
ApplicationKeyUpdateRequest
object
Request used to update an application key.
1 property
1 required
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
ApplicationKeyResponseMeta
object
Additional information related to the application key response.
2 properties
UserCreateRequest
object
Create a user.
1 property
1 required
UserInvitationRelationships
object
Relationships data for user invitation.
1 property
1 required
TeamOnCallRespondersData
object
Defines the main on-call responder object for a team, including relationships and metadata.
3 properties
1 required
RelationshipToRoleData
object
Relationship to role object.
2 properties
ApplicationKeyUpdateData
object
Object used to update an application key.
3 properties
3 required
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties
2 required
EscalationRelationshipsResponders
object
Lists the users involved in a specific step of the escalation policy.
1 property
TeamsResponseMetaPagination
object
Teams response metadata.
8 properties
PartialApplicationKeyAttributes
object
Attributes of a partial application key.
4 properties
UserTeamTeamType
string
User team team type
TeamAttributes
object
Team attributes
12 properties
2 required
TeamOnCallRespondersDataRelationshipsEscalations
object
Defines the escalation policy steps linked to the team's on-call configuration.
1 property
Role
object
Role object returned by the API.
4 properties
1 required
Organization
object
Organization object.
3 properties
1 required
ExternalUser
object
Definition of a user.
8 properties
RelationshipToTeamLinkData
object
Relationship between a link and a team
2 properties
2 required
ExternalUserMeta
object
Metadata associated with a user.
4 properties
TeamOnCallRespondersDataType
string
Represents the resource type for a group of users assigned to handle on-call duties within a team.
RelationshipToUsers
object
Relationship to users.
1 property
1 required
RelationshipToUserTeamUser
object
Relationship between team membership and user
1 property
1 required
EscalationType
string
Represents the resource type for individual steps in an escalation policy used during incident response.
ScheduleUserAttributes
object
Provides basic user information for a schedule, including a name and email address.
3 properties
PermissionsType
string
Permissions resource type.
ApplicationKeyResponseMetaPage
object
Additional information related to the application key response.
1 property
UserUpdateAttributes
object
Attributes of the edited user.
3 properties
PartialApplicationKey
object
Partial Datadog application key.
4 properties
TeamLinkType
string
Team link type
ApplicationKeysSort
string
Sorting options
RelationshipToRoles
object
Relationship to roles.
1 property
RelationshipToOrganizations
object
Relationship to organizations.
1 property
1 required
UserTeamUserType
string
User team user type
LeakedKeyType
string
The definition of LeakedKeyType object.
Team
object
A team
4 properties
3 required
TeamOnCallRespondersIncluded
Represents an union of related resources included in the response, such as users and escalation steps.
Pagination
object
Pagination object.
2 properties
TeamRelationshipsLinks
object
Links attributes.
1 property
ShiftDataRelationshipsUserDataType
string
Indicates that the related resource is of type 'users'.
Escalation
object
Represents an escalation policy step.
3 properties
1 required
RestrictionQueryListResponse
object
Response containing information about multiple restriction queries.
1 property
UserTeamIncluded
Included resources related to the team membership
PermissionsResponse
object
Payload with API-returned permissions.
1 property
ExternalUserPatchRequestOperationsItems
object
The definition of an individual patch operation in a patch request.
3 properties
RelationshipToUserTeamUserData
object
A user's relationship with a team
2 properties
2 required
UserTeamCreate
object
A user's relationship with a team
3 properties
1 required
UserTeamsResponse
object
Team memberships response
4 properties
ShiftDataRelationshipsUser
object
Defines the relationship between a shift and the user who is working that shift.
1 property
1 required
ResponseMetaAttributes
object
Object describing meta attributes of response.
1 property
UserInvitationDataAttributes
object
Attributes of a user invitation.
4 properties
ExternalUserPatchRequest
object
Request object for patching a user.
2 properties
ExternalUserEmailType
object
Email address for the user.
3 properties
RolesType
string
Roles type.
UserCreateData
object
Object to create a user.
3 properties
2 required
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Datadog 12
Other APIs Datadog publishes across the network.
Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Datadog APM Retention Filters API
#User
Where this information came from
This is an independent, third-party profile of Datadog Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.