ジャンプ先

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

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/Attribute Mapping SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 属性マッピングのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Attribute Mapping 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/Attribute Mapping Properties"
        }
    }
}

ネストされたスキーマ: 属性マッピングのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-attribute-name(required): string
  追加する属性の名前
• ds-cfg-data-type: string
  指定可能な値: [ "bigint", "binary", "bit", "blob", "boolean", "char", "clob", "date", "decimal", "double", "float", "integer", "longnvarchar", "longvarbinary", "longvarchar", "nchar", "nclob", "numeric", "nvarchar", "other", "real", "rowid", "smallint", "time", "timestamp", "tinyint", "varbinary", "varchar" ]

  属性値のデータ型
• ds-cfg-field-name(required): string
  この属性の値の移入に使用される、指定された表のフィールド
• ds-cfg-table-name(required): string
  属性値のフェッチ元となる表。これは、WorkflowElementに定義されたRDBMS表の一部として定義されたRDBMS表のいずれかの別名である必要があります
• ds-cfg-use-case-sensitive-match: boolean
  デフォルト値: true

  大/小文字が区別されない照合をこの属性に使用するかどうか
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-field-name",
        "ds-cfg-attribute-name",
        "ds-cfg-table-name"
    ],
    "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-field-name":{
            "description":"Field in the specified table from which the value for this attribute has to be populated ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-use-case-sensitive-match":{
            "description":"Whether case insensitive matching should be used for this attribute or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-attribute-name":{
            "description":"Name of the attribute to be added ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-table-name":{
            "description":"Table from which the attribute value has to be fetched. This has to be the alias of one of the RDBMS Tables defined as part of the RDBMS Tables defined for the WorkflowElement ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-data-type":{
            "description":"The data type of the attribute value ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "bigint",
                "binary",
                "bit",
                "blob",
                "boolean",
                "char",
                "clob",
                "date",
                "decimal",
                "double",
                "float",
                "integer",
                "longnvarchar",
                "longvarbinary",
                "longvarchar",
                "nchar",
                "nclob",
                "numeric",
                "nvarchar",
                "other",
                "real",
                "rowid",
                "smallint",
                "time",
                "timestamp",
                "tinyint",
                "varbinary",
                "varchar"
            ]
        }
    }
}

ネストされたスキーマ: 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."
        }
    }
}

先頭に戻る