ジャンプ先

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

DNによる一致と置換アイデンティティ・マッパーの変更

PATCH

/rest/v1/admin/{dn}

DNによる一致と置換アイデンティティ・マッパーの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要がある一致と置換アイデンティティ・マッパー

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): 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(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: 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

本文 ()

ルート・スキーマ: 一致と置換アイデンティティ・マッパーのPatchSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): 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/Match And Replace Identity Mapper SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 一致と置換アイデンティティ・マッパーのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Match And Replace Identity Mapper SearchResultEntry"
    }
}

ネストされたスキーマ: 一致と置換アイデンティティ・マッパーのSearchResultEntry

型: object

ソースを表示

• attributes(required): object 一致と置換アイデンティティ・マッパーのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Match And Replace Identity Mapper Properties"
        }
    }
}

ネストされたスキーマ: 一致と置換アイデンティティ・マッパーのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-enabled(required): boolean
  アイデンティティ・マッパーの使用が有効かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.extensions.MatchAndReplaceIdentityMapper

  一致と置換アイデンティティ・マッパーの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-match-attribute(required): array ds-cfg-match-attribute
  関連する正規表現によって処理した後の値が指定のID文字列と一致する属性の名前またはOIDを指定します。
• ds-cfg-match-base-dn: array ds-cfg-match-base-dn
  検索を実行して指定のID文字列をユーザー・エントリにマップするときに使用するベースDNを指定します。複数の値を指定すると、それらすべてのベースDNの下で検索が実行されます。
• ds-cfg-match-pattern(required): string
  アイデンティティ・マッパーの適用先エントリを識別するために使用される正規表現パターンを指定します。
• ds-cfg-priority: integer(int32)
  デフォルト値: 1

  このアイデンティティ・マッパーの優先度を指定します。
• ds-cfg-replace-pattern: string
  指定された正規表現パターンに一致するID文字列の部分文字列に使用する置換パターンを指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-match-attribute",
        "ds-cfg-match-pattern",
        "ds-cfg-enabled"
    ],
    "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 Match And Replace Identity Mapper implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.MatchAndReplaceIdentityMapper",
            "type":"string"
        },
        "ds-cfg-match-base-dn":{
            "description":"Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-replace-pattern":{
            "description":"Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-match-attribute":{
            "description":"Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression. ",
            "readOnly":false,
            "default":[
                "uid"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-match-pattern":{
            "description":"Specifies the regular expression pattern that is used to identify an entry that Identity Mapper applies to. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"Specifies the priority for this Identity Mapper. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Identity Mapper is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-match-attribute

型: array

関連する正規表現によって処理した後の値が指定のID文字列と一致する属性の名前またはOIDを指定します。

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

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression. ",
    "readOnly":false,
    "default":[
        "uid"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-match-base-dn

型: array

検索を実行して指定のID文字列をユーザー・エントリにマップするときに使用するベースDNを指定します。複数の値を指定すると、それらすべてのベースDNの下で検索が実行されます。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs. ",
    "readOnly":false,
    "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: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): 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."
        }
    }
}

先頭に戻る