ジャンプ先

• リクエスト
• レスポンス

すべてのスキーマの検索

get

/iam/directory/oud/scim/v1/Schemas

作成され、サポートされているスキーマの詳細を返します

リクエスト

この操作のリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/scim+json

200レスポンス

OK

本文()

ルート・スキーマ: SchemaSuccessResponse

型: object

ソースを表示

• Resources: array Resources
  作成されたスキーマの詳細。
• schemas: string
  デフォルト値: urn:ietf:params:scim:api:messages:2.0:ListResponse

  RESTメッセージ・スキーマ
• totalResults: integer(int32)
  返される検索結果エントリの数。

{
    "type":"object",
    "required":[
        "schemas",
        "totalResults",
        "Resources"
    ],
    "properties":{
        "schemas":{
            "description":"The REST message schema",
            "type":"string",
            "default":"urn:ietf:params:scim:api:messages:2.0:ListResponse"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Number of search result entries returned."
        },
        "Resources":{
            "type":"array",
            "description":"Details of the schemas that have been created.",
            "items":{
                "$ref":"#/definitions/SchemaSearchResultEntry"
            }
        }
    }
}

ネストされたスキーマ: Resources

型: array

作成されたスキーマの詳細。

ソースを表示

• 配列: オブジェクト SchemaSearchResultEntry

{
    "type":"array",
    "description":"Details of the schemas that have been created.",
    "items":{
        "$ref":"#/definitions/SchemaSearchResultEntry"
    }
}

ネストされたスキーマ: SchemaSearchResultEntry

型: object

ソースを表示

• attributes: array attributes
  特定のスキーマの属性。
• description: string
  特定のスキーマの説明。
• id: string
  特定のスキーマのID。
• meta: object meta
  特定のスキーマのメタ値。
• name: string
  特定のスキーマの名前。
• schemas: array schemas
  スキーマ・タイプに含めるスキーマ。

{
    "type":"object",
    "required":[
        "schemas",
        "id",
        "attributes",
        "name",
        "meta",
        "description"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to be included for the schema type.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "default":[
                "urn:ietf:params:scim:schemas:core:2.0:Schema"
            ]
        },
        "id":{
            "description":"The id of the particular schema.",
            "type":"string"
        },
        "attributes":{
            "description":"The attributes for the particular schema.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"The name of the particular schema.",
            "type":"string"
        },
        "meta":{
            "description":"The meta values for the particular schema.",
            "type":"object",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "description":"The description of the particular schema.",
            "type":"string"
        }
    }
}

ネストされたスキーマ: attributes

型: array

特定のスキーマの属性。

ソースを表示

• 配列: 文字列

{
    "description":"The attributes for the particular schema.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: meta

型: object

特定のスキーマのメタ値。

ソースを表示

• 配列: 文字列

{
    "description":"The meta values for the particular schema.",
    "type":"object",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: schemas

型: array

スキーマ・タイプに含めるスキーマ。

デフォルト値: [ "urn:ietf:params:scim:schemas:core:2.0:Schema" ]

ソースを表示

• 配列: 文字列

{
    "description":"The Schemas to be included for the schema type.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "default":[
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ]
}

406レスポンス

Not Acceptable

本文()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• detail: string
  操作に対して返されるエラー・メッセージ。
• schemas: string
  デフォルト値: urn:ietf:params:scim:api:messages:2.0:Error

  RESTメッセージ・タイプ
• status: integer(int32)
  操作に対して返されるHTTPステータス・エラー・コードを指定します。

{
    "type":"object",
    "required":[
        "schemas",
        "detail",
        "status"
    ],
    "properties":{
        "schemas":{
            "description":"The REST message type",
            "default":"urn:ietf:params:scim:api:messages:2.0:Error",
            "type":"string"
        },
        "detail":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the HTTP status error code returned for the operation."
        }
    }
}

先頭に戻る