openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Memberships API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Memberships
paths:
/api/v2/team/{team_id}/memberships:
get:
description: Get a paginated list of members for a team
operationId: GetTeamMemberships
parameters:
- description: None
in: path
name: team_id
required: true
schema:
type: string
example: abc-123-def
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: Specifies the order of returned team memberships
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/GetTeamMembershipsSort'
example: example_value
- description: Search query, can be user email or name
in: query
name: filter[keyword]
required: false
schema:
type: string
example: example_value
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamsResponse'
description: Represents a user's association to a team
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- teams_read
summary: Datadog Get Team Memberships
tags:
- Memberships
x-menu-order: 6
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/team/{team_id}/memberships/{user_id}:
x-merge-override:
delete: true
patch:
description: Update a user's membership attributes on a team.
operationId: UpdateTeamMembership
parameters:
- description: None
in: path
name: team_id
required: true
schema:
type: string
example: abc-123-def
- description: None
in: path
name: user_id
required: true
schema:
type: string
example: abc-123-def
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamResponse'
description: Represents a user's association to a team
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- teams_read
summary: Datadog Update a User's Membership Attributes on a Team
tags:
- Memberships
x-codegen-request-body-name: body
x-menu-order: 9
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/users/{user_uuid}/memberships:
get:
description: Get a list of memberships for a user
operationId: GetUserMemberships
parameters:
- description: None
in: path
name: user_uuid
required: true
schema:
type: string
example: abc-123-def
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamsResponse'
description: Represents a user's association to a team
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- teams_read
summary: Datadog Get User Memberships
tags:
- Memberships
x-menu-order: 1
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
UserTeam:
description: A user's relationship with a team
properties:
attributes:
$ref: '#/components/schemas/UserTeamAttributes'
id:
description: The ID of a user's relationship with a team
example: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835
type: string
relationships:
$ref: '#/components/schemas/UserTeamRelationships'
type:
$ref: '#/components/schemas/UserTeamType'
required:
- id
- type
type: object
x-merge-override:
required: false
RelationshipToUserData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
required:
- id
- type
type: object
x-merge-override:
required: false
UserTeamUpdate:
description: A user's relationship with a team
properties:
attributes:
$ref: '#/components/schemas/UserTeamAttributes'
type:
$ref: '#/components/schemas/UserTeamType'
required:
- type
type: object
UsersType:
default: users
description: Users resource type.
enum:
- users
example: users
type: string
x-enum-varnames:
- USERS
UserTeamRelationships:
description: Relationship between membership and a user
properties:
team:
$ref: '#/components/schemas/RelationshipToUserTeamTeam'
user:
$ref: '#/components/schemas/RelationshipToUserTeamUser'
type: object
RelationshipToUserTeamPermissionData:
description: Related user team permission data
properties:
id:
description: The ID of the user team permission
example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595
type: string
type:
$ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
type: object
x-merge-override:
required: false
GetTeamMembershipsSort:
description: Specifies the order of returned team memberships
enum:
- manager_name
- -manager_name
- name
- -name
- handle
- -handle
- email
- -email
type: string
x-enum-varnames:
- MANAGER_NAME
- _MANAGER_NAME
- NAME
- _NAME
- HANDLE
- _HANDLE
- EMAIL
- _EMAIL
TeamLinkType:
default: team_links
description: Team link type
enum:
- team_links
example: team_links
type: string
x-enum-varnames:
- TEAM_LINKS
RelationshipToRoles:
description: Relationship to roles.
properties:
data:
description: An array containing type and the unique identifier of a role.
items:
$ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
x-merge-override:
required: false
RelationshipToUserTeamPermission:
description: Relationship between a user team permission and a team
properties:
data:
$ref: '#/components/schemas/RelationshipToUserTeamPermissionData'
links:
$ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
x-merge-override:
required: false
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
UserResponseRelationships:
description: Relationships of the user object returned by the API.
properties:
org:
$ref: '#/components/schemas/RelationshipToOrganization'
other_orgs:
$ref: '#/components/schemas/RelationshipToOrganizations'
other_users:
$ref: '#/components/schemas/RelationshipToUsers'
roles:
$ref: '#/components/schemas/RelationshipToRoles'
type: object
x-merge-override:
properties: false
RelationshipToOrganizations:
description: Relationship to organizations.
properties:
data:
description: Relationships to organization objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
type: object
UserAttributes:
description: Attributes of user object returned by the API.
properties:
created_at:
description: Creation time of the user.
format: date-time
type: string
example: example_value
disabled:
description: Whether the user is disabled.
type: boolean
example: true
email:
description: Email of the user.
type: string
example: user@example.com
handle:
description: Handle of the user.
type: string
example: example_value
icon:
description: URL of the user's icon.
type: string
example: example_value
mfa_enabled:
description: If user has MFA enabled.
readOnly: true
type: boolean
example: true
modified_at:
description: Time that the user was last modified.
format: date-time
type: string
example: example_value
name:
description: Name of the user.
nullable: true
type: string
example: Example Monitor
service_account:
description: Whether the user is a service account.
type: boolean
example: true
status:
description: Status of the user.
type: string
example: OK
title:
description: Title of the user.
nullable: true
type: string
example: Example Monitor
verified:
description: Whether the user is verified.
type: boolean
example: true
type: object
UserTeamUserType:
default: users
description: User team user type
enum:
- users
example: users
type: string
x-enum-varnames:
- USERS
RelationshipToUserTeamTeamData:
description: The team associated with the membership
properties:
id:
description: The ID of the team associated with the membership
example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9
type: string
type:
$ref: '#/components/schemas/UserTeamTeamType'
required:
- id
- type
type: object
Team:
description: A team
properties:
attributes:
$ref: '#/components/schemas/TeamAttributes'
id:
description: The team's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
$ref: '#/components/schemas/TeamRelationships'
type:
$ref: '#/components/schemas/TeamType'
required:
- attributes
- id
- type
type: object
x-merge-override:
required: false
RelationshipToUserTeamTeam:
description: Relationship between team membership and team
properties:
data:
$ref: '#/components/schemas/RelationshipToUserTeamTeamData'
required:
- data
type: object
UserTeamResponse:
description: Team membership response
properties:
data:
$ref: '#/components/schemas/UserTeam'
included:
description: Resources related to the team memberships
items:
$ref: '#/components/schemas/UserTeamIncluded'
type: array
type: object
TeamRelationshipsLinks:
description: Links attributes.
properties:
related:
description: Related link.
example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
type: string
type: object
UserTeamType:
default: team_memberships
description: Team membership type
enum:
- team_memberships
example: team_memberships
type: string
x-enum-varnames:
- TEAM_MEMBERSHIPS
RelationshipToTeamLinks:
description: Relationship between a team and a team link
properties:
data:
description: Related team links
items:
$ref: '#/components/schemas/RelationshipToTeamLinkData'
type: array
links:
$ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
x-merge-override:
required: false
UserTeamIncluded:
description: Included resources related to the team membership
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/Team'
TeamType:
default: team
description: Team type
enum:
- team
example: team
type: string
x-enum-varnames:
- TEAM
RelationshipToUserTeamUserData:
description: A user's relationship with a team
properties:
id:
description: The ID of the user associated with the team
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
type:
$ref: '#/components/schemas/UserTeamUserType'
required:
- id
- type
type: object
x-merge-override:
required: false
UserTeamsResponse:
description: Team memberships response
properties:
data:
description: Team memberships response data
items:
$ref: '#/components/schemas/UserTeam'
type: array
included:
description: Resources related to the team memberships
items:
$ref: '#/components/schemas/UserTeamIncluded'
type: array
links:
$ref: '#/components/schemas/TeamsResponseLinks'
meta:
$ref: '#/components/schemas/TeamsResponseMeta'
type: object
RelationshipToRoleData:
description: Relationship to role object.
properties:
id:
description: The unique identifier of the role.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
type:
$ref: '#/components/schemas/RolesType'
type: object
x-merge-override:
required: false
User:
description: User object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/UserAttributes'
id:
description: ID of the user.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/UserResponseRelationships'
type:
$ref: '#/components/schemas/UsersType'
type: object
x-merge-override:
required: false
RelationshipToOrganizationData:
description: Relationship to organization object.
properties:
id:
description: ID of the organization.
example: 00000000-0000-beef-0000-000000000000
type: string
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- id
- type
type: object
TeamsResponseMeta:
description: Teams response metadata.
properties:
pagination:
$ref: '#/components/schemas/TeamsResponseMetaPagination'
type: object
TeamsResponseMetaPagination:
description: Teams response metadata.
properties:
first_offset:
description: The first offset.
format: int64
type: integer
example: 42
last_offset:
description: The last offset.
format: int64
type: integer
example: 42
limit:
description: Pagination limit.
format: int64
type: integer
example: 42
next_offset:
description: The next offset.
format: int64
type: integer
example: 42
offset:
description: The offset.
format: int64
type: integer
example: 42
prev_offset:
description: The previous offset.
format: int64
type: integer
example: 42
total:
description: Total results.
format: int64
type: integer
example: 42
type:
description: Offset type.
type: string
example: metric alert
type: object
UserTeamTeamType:
default: team
description: User team team type
enum:
- team
example: team
type: string
x-enum-varnames:
- TEAM
TeamAttributes:
description: Team attributes
properties:
avatar:
description: Unicode representation of the avatar for the team, limited to a single grapheme
example: 🥑
nullable: true
type: string
banner:
description: Banner selection for the team
format: int64
nullable: true
type: integer
example: 42
created_at:
description: Creation date of the team
format: date-time
type: string
example: example_value
description:
description: Free-form markdown description/content for the team's homepage
nullable: true
type: string
example: example_value
handle:
description: The team's identifier
example: example-team
maxLength: 195
type: string
hidden_modules:
description: Collection of hidden modules for the team
items:
description: String identifier of the module
type: string
type: array
link_count:
description: The number of links belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
modified_at:
description: Modification date of the team
format: date-time
type: string
example: example_value
name:
description: The name of the team
example: Example Team
maxLength: 200
type: string
summary:
description: A brief summary of the team, derived from the `description`
maxLength: 120
nullable: true
type: string
example: example_value
user_count:
description: The number of users belonging to the team
format: int32
maximum: 2147483647
readOnly: true
type: integer
example: 42
visible_modules:
description: Collection of visible modules for the team
items:
description: String identifier of the module
type: string
type: array
required:
- handle
- name
type: object
UserTeamUpdateRequest:
description: Team membership request
properties:
data:
$ref: '#/components/schemas/UserTeamUpdate'
required:
- data
type: object
UserTeamPermissionType:
default: user_team_permissions
description: User team permission type
enum:
- user_team_permissions
example: user_team_permissions
type: string
x-enum-varnames:
- USER_TEAM_PERMISSIONS
RolesType:
default: roles
description: Roles type.
enum:
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
RelationshipToTeamLinkData:
description: Relationship between a link and a team
properties:
id:
description: The team link's identifier
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamLinkType'
required:
- id
- type
type: object
x-merge-override:
required: false
OrganizationsType:
default: orgs
description: Organizations resource type.
enum:
- orgs
example: orgs
type: string
x-enum-varnames:
- ORGS
UserTeamRole:
description: The user's role within the team
enum:
- admin
nullable: true
type: string
x-enum-varnames:
- ADMIN
RelationshipToUsers:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
type: object
UserTeamAttributes:
description: Team membership attributes
properties:
provisioned_by:
description: 'The mechanism responsible for provisioning the team relationship.
Possible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.'
nullable: true
readOnly: true
type: string
example: example_value
provisioned_by_id:
description: UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
nullable: true
readOnly: true
type: string
example: abc-123-def
role:
$ref: '#/components/schemas/UserTeamRole'
type: object
RelationshipToUserTeamUser:
description: Relationship between team membership and user
properties:
data:
$ref: '#/components/schemas/RelationshipToUserTeamUserData'
required:
- data
type: object
RelationshipToOrganization:
description: Relationship to an organization.
properties:
data:
$ref: '#/components/schemas/RelationshipToOrganizationData'
required:
- data
type: object
TeamRelationships:
description: Resources related to a team
properties:
team_links:
$ref: '#/components/schemas/RelationshipToTeamLinks'
user_team_permissions:
$ref: '#/components/schemas/RelationshipToUserTeamPermission'
type: object
TeamsResponseLinks:
description: Teams response links.
properties:
first:
description: First link.
type: string
example: example_value
last:
description: Last link.
nullable: true
type: string
example: example_value
next:
description: Next link.
type: string
example: example_value
prev:
description: Previous link.
nullable: true
type: string
example: example_value
self:
description: Current link.
type: string
example: example_value
type: object
parameters:
PageSize:
description: Size for a given page. The maximum allowed value is 100.
in: query
name: page[size]
required: false
schema:
default: 10
example: 10
format: int64
type: integer
PageNumber:
description: Specific page number to return.
in: query
name: page[number]
required: false
schema:
default: 0
example: 0
format: int64
type: integer
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team na
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/openapi/datadog-memberships-api-openapi.yml