Get team hierarchy members - Teams

경고Note: This endpoint is in Preview and is subject to change. If you have any feedback, contact Datadog support.

GEThttps://api.datadoghq.com/api/v2/team/{team_id}/membershttps://api.us3.datadoghq.com/api/v2/team/{team_id}/membershttps://api.us5.datadoghq.com/api/v2/team/{team_id}/membershttps://api.datadoghq.eu/api/v2/team/{team_id}/membershttps://api.ap1.datadoghq.com/api/v2/team/{team_id}/membershttps://api.ap2.datadoghq.com/api/v2/team/{team_id}/membershttps://api.uk1.datadoghq.com/api/v2/team/{team_id}/membershttps://api.ddog-gov.com/api/v2/team/{team_id}/membershttps://api.us2.ddog-gov.com/api/v2/team/{team_id}/members

개요

List the direct and inherited members of a team, deduplicated by user. Members of descendant teams are included unless filter[is_direct_only] is true. Datadog support users are always excluded.

Use page[number] and page[size] to paginate through the results. Invalid query parameters return a JSON:API error with status 400. Invalid or unknown team UUIDs return status 404.

This endpoint requires the teams_read permission.

OAuth apps require the teams_read authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

team_id [required]

string

UUID of the requested root team.

쿼리 문자열

이름

유형

설명

filter[is_direct_only]

boolean

Return only direct members. By default, members inherited from descendant teams are also returned.

Default: false

filter[include_service_accounts]

boolean

Include service accounts. Datadog support users are always excluded.

Default: true

filter[keyword]

string

Filter by a case-insensitive substring of the user name, handle, or email.

include

string

Comma-separated resources to include: user and team. The included team is the requested team. Whitespace is trimmed, and duplicate or empty entries are ignored.

sort

string

Comma-separated sort fields: name, handle, is_direct, and provisioned_by. Fields are applied in order, each optionally prefixed with - for descending order. By default, team admins come first, followed by other direct members, then inherited members, sorted by name within each group.

page[number]

integer

Zero-based page number. Negative values become 0. Defaults to 0.

Default: 0

page[size]

integer

Requested number of members per page. Defaults to and maxes out at 100.

Default: 100

응답

Direct and inherited members of the requested team.

항목

유형

설명

data [required]

[object]

Membership relationships for users who belong to the requested team or inherit membership through its descendant teams. Each user appears once, even if they belong to multiple teams in the hierarchy. Each relationship identifies the user and requested team, and indicates whether the user is a direct member of the requested team.

included

[<oneOf>]

Requested users and the team. May be absent when the result is empty, even if requested.

links [required]

object

Page navigation links. Unavailable links are omitted.

meta [required]

object

Pagination metadata for the filtered members.

{
  "data": [
    {
      "attributes": {
        "direct_role": "member",
        "is_direct": true,
        "provisioned_by": "manual",
        "provisioned_by_id": "00000000-0000-0000-0000-000000000003"
      },
      "id": "UserTeamRelationship:692e8073-12c4-4c71-8408-5090bd44c9c8:00000000-0000-0000-0000-000000000001",
      "relationships": {
        "team": {
          "data": {
            "id": "692e8073-12c4-4c71-8408-5090bd44c9c8",
            "type": "teams"
          }
        },
        "user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000001",
            "type": "users"
          }
        }
      },
      "type": "user_team_relationship"
    }
  ],
  "included": [
    {
      "attributes": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "disabled": false,
        "email": "string",
        "handle": "string",
        "icon": "string",
        "last_login_time": "2019-09-19T10:00:00.000Z",
        "mfa_enabled": false,
        "modified_at": "2019-09-19T10:00:00.000Z",
        "name": "string",
        "service_account": false,
        "status": "string",
        "title": "string",
        "uuid": "string",
        "verified": false
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "type": "users"
    }
  ],
  "links": {
    "first": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "last": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "next": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "prev": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "self": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100"
  },
  "meta": {
    "page": {
      "first_offset": 0,
      "last_offset": 0,
      "limit": 100,
      "next_offset": null,
      "offset": 0,
      "prev_offset": null,
      "total": 2,
      "type": "offset_limit"
    }
  }
}

Bad Request

API error response.

항목

유형

설명

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Unauthorized

API error response.

항목

유형

설명

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

항목

유형

설명

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 예시

Get team hierarchy members

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export team_id="692e8073-12c4-4c71-8408-5090bd44c9c8"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/team/${team_id}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"