이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

SCIM

Provision Datadog users and teams using SCIM APIs.

Note: SCIM provisioning for Datadog teams is only available for select organizations at this point. Request access by contacting Datadog support, or see the SCIM page for more information.

List users

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/scim/Usershttps://api.datadoghq.eu/api/v2/scim/Usershttps://api.ddog-gov.com/api/v2/scim/Usershttps://api.datadoghq.com/api/v2/scim/Usershttps://api.us3.datadoghq.com/api/v2/scim/Usershttps://api.us5.datadoghq.com/api/v2/scim/Users

개요

List users in the organization. Results are paginated by startIndex and count parameters. Results can be narrowed down by the filter parameter. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

쿼리 문자열

이름

유형

설명

startIndex

integer

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

count

integer

Specifies the number of users to be returned.

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.

Expand All

항목

유형

설명

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": false,
      "emails": [
        {
          "primary": false,
          "type": "string",
          "value": "string"
        }
      ],
      "id": "string",
      "meta": {
        "created": "2024-10-17T12:53:35.793Z",
        "lastModified": "2024-10-19T12:53:35.793Z",
        "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
        "resourceType": "User"
      },
      "name": {
        "formatted": "string"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "title": "string",
      "userName": "string"
    }
  ],
  "itemsPerPage": "integer",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": "integer",
  "totalResults": "integer"
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Users" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                

Create user

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/scim/Usershttps://api.datadoghq.eu/api/v2/scim/Usershttps://api.ddog-gov.com/api/v2/scim/Usershttps://api.datadoghq.com/api/v2/scim/Usershttps://api.us3.datadoghq.com/api/v2/scim/Usershttps://api.us5.datadoghq.com/api/v2/scim/Users

개요

Create a new user. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

요청

Body Data (required)

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

응답

Created

Definition of a user.

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/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"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "Mr.",
  "userName": "john.doe@datadoghq.com"
}
EOF

                

Get user

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.eu/api/v2/scim/Users/{user_uuid}https://api.ddog-gov.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us3.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us5.datadoghq.com/api/v2/scim/Users/{user_uuid}

개요

Get a single user using the user_uuid. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

user_uuid [required]

string

None

응답

Definition of a user.

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Path parameters
export user_uuid="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                

Update user

v2 (latest)

PUT https://api.ap1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.eu/api/v2/scim/Users/{user_uuid}https://api.ddog-gov.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us3.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us5.datadoghq.com/api/v2/scim/Users/{user_uuid}

개요

Update the user with the given user_uuid. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

user_uuid [required]

string

None

요청

Body Data (required)

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

응답

Definition of a user.

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Path parameters
export user_uuid="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Users/${user_uuid}" \
-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"
    }
  ],
  "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
  "name": {
    "formatted": "John Doe"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "Mr.",
  "userName": "john.doe@datadoghq.com"
}
EOF

                

Patch user

v2 (latest)

PATCH https://api.ap1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.eu/api/v2/scim/Users/{user_uuid}https://api.ddog-gov.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us3.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us5.datadoghq.com/api/v2/scim/Users/{user_uuid}

개요

Patch the user with the given user_uuid. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

user_uuid [required]

string

None

요청

Body Data (required)

Expand All

항목

유형

설명

Operations

[object]

A list of update operations to be performed on a user.

schemas

[string]

Input JSON Schemas

{
  "Operations": [
    {
      "op": "string",
      "path": "title",
      "value": "undefined"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

응답

Definition of a user.

Expand All

항목

유형

설명

active

boolean

A Boolean value indicating the User's administrative status.

emails

[object]

Email addresses for the user.

string

The identifier of the resource. Not required when creating a user.

meta

object

Metadata associated with a user.

name

object

The components of user's real name

schemas

[string]

User JSON Schemas.

title

string

The user's title.

userName

string

Unique identifier for the User.

{
  "active": false,
  "emails": [
    {
      "primary": false,
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c",
    "resourceType": "User"
  },
  "name": {
    "formatted": "string"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "title": "string",
  "userName": "string"
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Path parameters
export user_uuid="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Users/${user_uuid}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "title",
      "value": "CEO"
    },
    {
      "op": "replace",
      "value": {
        "name": {
          "formatted": "John Doe"
        }
      }
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

                

Delete user

v2 (latest)

DELETE https://api.ap1.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.eu/api/v2/scim/Users/{user_uuid}https://api.ddog-gov.com/api/v2/scim/Users/{user_uuid}https://api.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us3.datadoghq.com/api/v2/scim/Users/{user_uuid}https://api.us5.datadoghq.com/api/v2/scim/Users/{user_uuid}

개요

Delete the group with the given user_uuid. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

user_uuid [required]

string

None

응답

No Content

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Path parameters
export user_uuid="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Users/${user_uuid}" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                

List groups

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/scim/Groupshttps://api.datadoghq.eu/api/v2/scim/Groupshttps://api.ddog-gov.com/api/v2/scim/Groupshttps://api.datadoghq.com/api/v2/scim/Groupshttps://api.us3.datadoghq.com/api/v2/scim/Groupshttps://api.us5.datadoghq.com/api/v2/scim/Groups

개요

List groups in the organization. Results are paginated by startIndex and count parameters. Results can be narrowed down by the filter parameter. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

쿼리 문자열

이름

유형

설명

startIndex

integer

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

count

integer

Specifies the number of groups to be returned.

filter

string

Specifies the url encoded filter to use to narrow down the results. Filters can be in the form of displayName eq <group name> or externalId eq <external id of group> or id eq <group id> and members eq <user uuid> or members eq <user uuid> and id eq <group id>.

응답

List groups response object.

Expand All

항목

유형

설명

Resources

[object]

List of groups matching the request criteria.

itemsPerPage

int64

Number of groups returned per page.

schemas

[string]

List response JSON Schemas.

startIndex

int64

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

totalResults

int64

Total number of groups matching the request criteria.

{
  "Resources": [
    {
      "displayName": "My test group",
      "externalId": "346af543-e5ab-4855-937d-133231cd59ed",
      "id": "0e80d350-9519-4771-9aa8-ce849fc36c20",
      "members": [
        {
          "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
          "display": "John Doe",
          "type": "User",
          "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
        }
      ],
      "meta": {
        "created": "2024-10-17T12:53:35.793Z",
        "lastModified": "2024-10-19T12:53:35.793Z",
        "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ]
    }
  ],
  "itemsPerPage": "integer",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": "integer",
  "totalResults": "integer"
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                

Create group

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/scim/Groupshttps://api.datadoghq.eu/api/v2/scim/Groupshttps://api.ddog-gov.com/api/v2/scim/Groupshttps://api.datadoghq.com/api/v2/scim/Groupshttps://api.us3.datadoghq.com/api/v2/scim/Groupshttps://api.us5.datadoghq.com/api/v2/scim/Groups

개요

Create a new group. The group may contain members. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

요청

Body Data (required)

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

응답

Created

Definition of a group.

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "displayName": "Group 1",
  "externalId": "group1",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/d34a5f93-5690-4d3f-a293-f2ad5c7a82a4",
      "display": "John Doe",
      "type": "User",
      "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4"
    },
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "Jane Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}
EOF

                

Get group

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.eu/api/v2/scim/Groups/{group_id}https://api.ddog-gov.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us3.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us5.datadoghq.com/api/v2/scim/Groups/{group_id}

개요

Get a single group using the group_id. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

group_id [required]

string

None

응답

Definition of a group.

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Path parameters
export group_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups/${group_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                

Update group

v2 (latest)

PUT https://api.ap1.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.eu/api/v2/scim/Groups/{group_id}https://api.ddog-gov.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us3.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us5.datadoghq.com/api/v2/scim/Groups/{group_id}

개요

Update the group with the given group_id. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

group_id [required]

string

None

요청

Body Data (required)

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

응답

Definition of a group.

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Conflict

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Path parameters
export group_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups/${group_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "displayName": "Group 1",
  "externalId": "group1",
  "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/d34a5f93-5690-4d3f-a293-f2ad5c7a82a4",
      "display": "John Doe",
      "type": "User",
      "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4"
    },
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "Jane Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}
EOF

                

Patch group

v2 (latest)

PATCH https://api.ap1.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.eu/api/v2/scim/Groups/{group_id}https://api.ddog-gov.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us3.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us5.datadoghq.com/api/v2/scim/Groups/{group_id}

개요

Patch the group with the given group_id. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

group_id [required]

string

None

요청

Body Data (required)

Expand All

항목

유형

설명

Operations

[object]

A list of update operations to be performed on a group.

schemas

[string]

Input JSON Schemas

{
  "Operations": [
    {
      "op": "string",
      "path": "members",
      "value": "{\n    \"displayName\": \"Real new group\",\n    \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

응답

Definition of a group.

Expand All

항목

유형

설명

displayName

string

A human-readable name for the group.

externalId

string

An identifier for the resource as defined by the provisioning client.

string

The identifier of the resource. Not required when creating a group.

members

[object]

Members of the group.

meta

object

Metadata associated with a group.

schemas

[string]

Input JSON Schemas.

{
  "displayName": "string",
  "externalId": "string",
  "id": "string",
  "members": [
    {
      "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
      "display": "John Doe",
      "type": "User",
      "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6"
    }
  ],
  "meta": {
    "created": "2024-10-17T12:53:35.793Z",
    "lastModified": "2024-10-19T12:53:35.793Z",
    "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  ## json-request-body
# 

# Path parameters
export group_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups/${group_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "Operations": [
    {
      "op": "replace",
      "path": "None",
      "value": {
        "displayName": "Real new group",
        "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad"
      }
    },
    {
      "op": "add",
      "path": "None",
      "value": {
        "members": [
          {
            "$ref": "https://app.datadoghq.com/api/scim/v2/Users/f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9",
            "displayName": "Bob Smith",
            "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9"
          }
        ]
      }
    },
    {
      "op": "remove",
      "path": "members[value eq \"fddf0cf2-9b60-11ef-ad4b-d6754a54a839\"]",
      "value": null
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
EOF

                

Delete group

v2 (latest)

DELETE https://api.ap1.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.eu/api/v2/scim/Groups/{group_id}https://api.ddog-gov.com/api/v2/scim/Groups/{group_id}https://api.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us3.datadoghq.com/api/v2/scim/Groups/{group_id}https://api.us5.datadoghq.com/api/v2/scim/Groups/{group_id}

개요

Delete the group with the given group_id. This endpoint requires all of the following permissions:

user_access_invite

user_access_manage

OAuth apps require the user_access_invite, user_access_manage authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

group_id [required]

string

None

응답

No Content

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 사례

                  # Path parameters
export group_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Groups/${group_id}" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

                