ユーザー一覧を取得する - SCIM

GEThttps://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/Users

概要

オーガニゼーション内のユーザーを一覧表示します。結果は startIndex と count パラメーターでページネーションされます。 filter パラメーターを使用して結果を絞り込むことができます。

This endpoint requires all of the following permissions:

user_access_invite
user_access_manage

引数

クエリ文字列

名前

タイプ

説明

startIndex

integer

Specifies the start index to fetch the results (1-indexed).

Default: 1

count

integer

Specifies the number of users to be returned.

Default: 20

filter

string

Specifies the url encoded filter to use to narrow down the results. Filter should be of the form userName eq <user name>.

応答

List users response object.

フィールド

タイプ

説明

Resources

[object]

List of users matching the request criteria.

itemsPerPage

int64

Number of users returned per page.

schemas

[string]

List response JSON Schemas.

startIndex

int64

Starting index of the users for this page (1-indexed).

totalResults

int64

Total number of users matching the request criteria.

{
  "Resources": [
    {
      "active": true,
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "john.doe@datadoghq.com"
        }
      ],
      "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
      "meta": {
        "created": "2024-11-22T15:05:52.055138963Z",
        "lastModified": "2024-11-22T15:05:52.055139017Z",
        "location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
        "resourceType": "User"
      },
      "name": {
        "formatted": "John Doe"
      },
      "roles": [
        {
          "display": "Datadog Read Only Role",
          "value": "00000000-0000-0000-0000-000000000001"
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "title": "Mr.",
      "userName": "john.doe@datadoghq.com"
    },
    {
      "active": true,
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "jane.doe@datadoghq.com"
        }
      ],
      "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a",
      "meta": {
        "created": "2024-11-22T15:05:52.055139748Z",
        "lastModified": "2024-11-22T15:05:52.055139813Z",
        "location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a",
        "resourceType": "User"
      },
      "name": {
        "formatted": "Jane Doe"
      },
      "roles": [
        {
          "display": "Datadog Standard Role",
          "value": "00000000-0000-0000-0000-000000000002"
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "title": "Mrs.",
      "userName": "jane.doe@datadoghq.com"
    }
  ],
  "itemsPerPage": 2,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 2
}

Bad Request

API error response.

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

コード例

ユーザー一覧を取得する

# 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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-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/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"