ジャンプ先

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

グループの変更

patch

/iam/directory/oud/scim/v1/Groups/{entryUUID}

EntryUUIDを指定します

リクエスト

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

• application/scim+json

パス・パラメータ

• entryUUID: string
  変更するエントリのLDAP DN。

本文()

変更する必要があるエントリ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• Operations: array Operations
  ユーザーに対して実行する変更(パッチ操作)。
• schemas: array schemas
  パッチ操作タイプのスキーマ

{
    "type":"object",
    "required":[
        "schemas",
        "Operations"
    ],
    "properties":{
        "schemas":{
            "description":"The schema for the Patch operation type",
            "default":[
                "urn:ietf:params:scim:api:messages:2.0:PatchOp"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the User.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        }
    }
}

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

型: array

ユーザーに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the User.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: array

パッチ操作タイプのスキーマ

デフォルト値: [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]

ソースを表示

• 配列: 文字列

{
    "description":"The schema for the Patch operation type",
    "default":[
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• op: string
  指定可能な値: [ "add", "delete", "replace" ]

  パッチ操作のタイプ。
• path: string
  変更するエントリ属性のパス。
• value: array value
  • 住所のような複合属性全体
  • 単純な属性の値。更新する属性値。

{
    "type":"object",
    "required":[
        "op",
        "path",
        "value"
    ],
    "properties":{
        "op":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace"
            ]
        },
        "path":{
            "type":"string",
            "description":"The path of the entry attribute to be modified."
        },
        "value":{
            "type":"array",
            "description":"<ul><li>The entire complex attributes like addresses</li><li>The value of simple attribute</li</ul>The attribute values to be updated.",
            "items":{
                "type":"object"
            }
        }
    }
}

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

型: array

• 住所のような複合属性全体
• 単純な属性の値。更新する属性値。

ソースを表示

• 配列: オブジェクト items

{
    "type":"array",
    "description":"<ul><li>The entire complex attributes like addresses</li><li>The value of simple attribute</li</ul>The attribute values to be updated.",
    "items":{
        "type":"object"
    }
}

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

型: object

先頭に戻る

レスポンス

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

• application/scim+json

200レスポンス

OK

本文()

ルート・スキーマ: GroupSuccessResponse

型: object

ソースを表示

• Resources: array Resources
  LDAP操作後に返される検索結果エントリの数。
• 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":"Specifies the number of entries created, and returned."
        },
        "Resources":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/GroupSearchResultEntry"
            }
        }
    }
}

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

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• 配列: オブジェクト GroupSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/GroupSearchResultEntry"
    }
}

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

型: object

ソースを表示

• schemas: string
  指定可能な値: [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group" ]

  スキーマ・タイプに含めるスキーマ。
• urn:ietf:params:scim:schemas:core:2.0:Group(optional): object Core Group Properties
• urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group(optional): object Oracle specific Group Properties

{
    "type":"object",
    "required":[
        "schemas"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to be included for the schema type.",
            "type":"string",
            "enum":[
                "urn:ietf:params:scim:schemas:core:2.0:Group",
                "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group"
            ]
        },
        "urn:ietf:params:scim:schemas:core:2.0:Group":{
            "$ref":"#/definitions/Core Group Properties"
        },
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group":{
            "$ref":"#/definitions/Oracle specific Group Properties"
        }
    }
}

ネストされたスキーマ: Core Group Properties

型: object

ソースを表示

• displayName: string
  グループの表示名。
• members: array members
  グループに属するメンバー。

{
    "type":"object",
    "required":[
        "members",
        "displayName"
    ],
    "properties":{
        "members":{
            "type":"array",
            "description":"Members belonging to the Group.",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"Display name for the group."
        }
    }
}

ネストされたスキーマ: Oracle specific Group Properties

型: object

ソースを表示

• businessCategory(optional): array businessCategory
  グループのビジネス・カテゴリ。
• description(optional): array description
  グループの説明。
• o(optional): array o
  グループが属する組織。
• objectClass(optional): array objectClass
  グループに必要なオブジェクト・クラス。
• ou(optional): array ou
  グループが属する組織単位。
• owner(optional): array owner
  グループの所有者

{
    "type":"object",
    "properties":{
        "objectClass":{
            "type":"array",
            "description":"Objectclass(es) required for the Group.",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "type":"array",
            "description":"Description of the Group.",
            "items":{
                "type":"string"
            }
        },
        "owner":{
            "type":"array",
            "description":"Owner of the group.",
            "items":{
                "type":"string"
            }
        },
        "ou":{
            "type":"array",
            "description":"Organizational Unit the Group is a part of.",
            "items":{
                "type":"string"
            }
        },
        "businessCategory":{
            "type":"array",
            "description":"Buisness Category of the Group.",
            "items":{
                "type":"string"
            }
        },
        "o":{
            "type":"array",
            "description":"Organiation the group is a part of.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

グループに属するメンバー。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Members belonging to the Group.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループのビジネス・カテゴリ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Buisness Category of the Group.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループの説明。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Description of the Group.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループが属する組織。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Organiation the group is a part of.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループに必要なオブジェクト・クラス。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) required for the Group.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループが属する組織単位。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Organizational Unit the Group is a part of.",
    "items":{
        "type":"string"
    }
}

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

型: array

グループの所有者

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Owner of the group.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

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

先頭に戻る