List schemas - SCIM - Datadog API

GEThttps://api.datadoghq.com/api/v2/scim/Schemashttps://api.us3.datadoghq.com/api/v2/scim/Schemashttps://api.us5.datadoghq.com/api/v2/scim/Schemashttps://api.datadoghq.eu/api/v2/scim/Schemashttps://api.ap1.datadoghq.com/api/v2/scim/Schemashttps://api.ap2.datadoghq.com/api/v2/scim/Schemashttps://api.uk1.datadoghq.com/api/v2/scim/Schemashttps://api.ddog-gov.com/api/v2/scim/Schemashttps://api.us2.ddog-gov.com/api/v2/scim/Schemas

概要

List the SCIM schemas supported by this service provider. See RFC 7644 Section 4 for more information.

This endpoint requires all of the following permissions:

user_access_invite
user_access_manage

応答

List schemas response object.

フィールド

タイプ

説明

Resources

[object]

List of schemas supported by this SCIM service provider.

attributes

[object]

A list of attributes that make up the schema.

canonicalValues

[string]

A collection of canonical values.

caseExact

boolean

A Boolean value that specifies whether or not a string attribute is case sensitive.

description

string

The attribute's human-readable description.

multiValued

boolean

A Boolean value indicating an attribute's plurality.

mutability

string

A single keyword indicating the circumstances under which the value of the attribute can be (re)defined.

name

string

The attribute's name.

referenceTypes

[string]

A list of resource types or external resources the reference may refer to.

required

boolean

A Boolean value that specifies whether or not the attribute is required.

returned

string

A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request.

subAttributes

[object]

A list of sub-attributes for complex attributes.

type

string

The data type of the attribute.

uniqueness

string

A single keyword value that specifies how the service provider enforces uniqueness of attribute values.

description

string

Human-readable description of the schema.

id

string

The unique URI of the schema.

meta

object

Metadata associated with a SCIM schema.

name

string

The human-readable name of the schema.

itemsPerPage

int64

Number of schemas returned per page.

schemas

[string]

List response JSON Schemas.

startIndex

int64

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

totalResults

int64

Total number of schemas.

{
  "Resources": [
    {
      "description": "User Schema",
      "id": "urn:ietf:params:scim:schemas:core:2.0:User",
      "meta": {
        "location": "https://app.datadoghq.com/api/v2/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:User",
        "resourceType": "Schema"
      },
      "name": "User"
    },
    {
      "description": "Group Schema",
      "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
      "meta": {
        "location": "https://app.datadoghq.com/api/v2/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group",
        "resourceType": "Schema"
      },
      "name": "Group"
    }
  ],
  "itemsPerPage": 2,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 2
}

Not Found

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"
  ]
}

コード例

List schemas

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