ジャンプ先

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

DNによるグループRESTリソースの変更

PATCH

/rest/v1/admin/{dn}

DNによるグループRESTリソースの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるグループRESTリソース

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls(optional): array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations: array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

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

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

型: object

ソースを表示

• attribute: string
  変更するエントリ属性。
• opType: string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values(optional): array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: グループRESTリソースのPatchSuccessResponse

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Group REST Resource SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト グループRESTリソースのSearchResultEntry

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

ネストされたスキーマ: グループRESTリソースのSearchResultEntry

型: object

ソースを表示

• attributes: object グループRESTリソースのプロパティ
• dn: string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Group REST Resource Properties"
        }
    }
}

ネストされたスキーマ: グループRESTリソースのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds - cfg - core-schema - rn: string
  コア・リソースのスキーマ。
• ds-cfg-enabled: boolean
  RESTリソースが有効かどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: com.oracle.scim.resources.groups.GroupResource

  グループRESTリソースの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-resource-add-template-basedn: string
  リソース・タイプが追加されるbase-dnを指定します。
• ds-cfg-resource-add-template-rdn-attr-type: string
  デフォルト値: cn

  リソース・タイプの追加時に使用されるrdn属性タイプを指定します。
• ds-cfg-resource-attr-map(optional): array ds-cfg-resource-attr-map
  TODO
• ds-cfg-resource-containers(optional): array ds-cfg-resource-containers
  このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します
• ds-cfg-resource-def-filter(optional): string
  デフォルト値: objectclass=groupOfUniqueNames

  TODO
• ds-cfg-resource-end-point: string
  デフォルト値: /Groups

  RESTリソース・エンドポイントURLを指定します。
• ds-cfg-resource-id-attr(optional): string
  デフォルト値: entryUUID

  リソースのID属性を指定します。
• ds-cfg-resource-name: string
  デフォルト値: Group

  RESTリソース名を指定します。
• ds-cfg-rest-ldap-objectclasses(optional): array ds-cfg-rest-ldap-objectclasses
  TODO
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-resource-add-template-basedn",
        "ds-cfg-resource-end-point",
        "ds-cfg-resource-name",
        "ds-cfg-core-schema-urn",
        "ds-cfg-enabled",
        "ds-cfg-resource-add-template-rdn-attr-type"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Group REST Resource implementation. ",
            "readOnly":false,
            "default":"com.oracle.scim.resources.groups.GroupResource",
            "type":"string"
        },
        "ds-cfg-resource-add-template-basedn":{
            "description":"Specifies the base-dn where the resource type will be added. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rest-ldap-objectclasses":{
            "description":"TODO ",
            "readOnly":false,
            "default":[
                "groupOfUniqueNames"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-resource-id-attr":{
            "description":"Specifies the id attribute of the resource. ",
            "readOnly":false,
            "default":"entryUUID",
            "type":"string"
        },
        "ds-cfg-resource-containers":{
            "description":"Specifies one or more alternate DNs that can be used to bind to the server as this root user. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-resource-end-point":{
            "description":"Specifies the REST resource end point URL. ",
            "readOnly":false,
            "default":"/Groups",
            "type":"string"
        },
        "ds-cfg-resource-def-filter":{
            "description":"TODO ",
            "readOnly":false,
            "default":"objectclass=groupOfUniqueNames",
            "type":"string"
        },
        "ds-cfg-resource-name":{
            "description":"Specifies the REST resource name. ",
            "readOnly":false,
            "default":"Group",
            "type":"string"
        },
        "ds-cfg-core-schema-urn":{
            "description":"The core resource's schema which. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the REST Resource is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-resource-add-template-rdn-attr-type":{
            "description":"Specifies the rdn attribute type that will be used while adding a resource type. ",
            "readOnly":false,
            "default":"cn",
            "type":"string"
        },
        "ds-cfg-resource-attr-map":{
            "description":"TODO ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-resource-attr-map

型: array

TODO

ソースを表示

• 配列: 文字列

{
    "description":"TODO ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-resource-containers

型: array

このルート・ユーザーとしてサーバーにバインドするために使用できる1つ以上の代替DNを指定します

ソースを表示

• 配列: 文字列

{
    "description":"Specifies one or more alternate DNs that can be used to bind to the server as this root user. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-rest-ldap-objectclasses

型: array

TODO

デフォルト値: [ "groupOfUniqueNames" ]

ソースを表示

• 配列: 文字列

{
    "description":"TODO ",
    "readOnly":false,
    "default":[
        "groupOfUniqueNames"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode(optional): integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message: string
  操作に対して返されるエラー・メッセージ。
• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る