Oracle Unified Directory管理REST API

属性マッピングの追加、検索、比較または削除

POST

/rest/v1/admin

属性マッピングの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要がある属性マッピング

ルート・スキーマ: 属性マッピングのPOSTRequest

型: object

ソースを表示

assertion: string

LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes: object 属性マッピングのプロパティ
base: string

LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
controls: array controls

LDAP操作のためにサーバーに送信するLDAP制御。
dn: string

作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
filter: string

LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
msgType(required): string

指定可能な値: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

RESTメッセージ・タイプ
requiredAttributes: array requiredAttributes

エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
scope: string

指定可能な値: [ "base", "sub", "one" ]

LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Attribute Mapping Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

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

型: 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"
            ]
        }
    }
}

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

型: array

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

ソースを表示

配列: 文字列

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

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

型: array

エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

ソースを表示

配列: 文字列

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

配列: 文字列

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 属性マッピングのSuccessResponse

型: object

ソースを表示

compareResult: boolean

LDAP比較操作の結果を示します。
msgType(required): string

指定可能な値: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

RESTメッセージ・タイプ
searchResultEntries(required): array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults(required): integer(int32)

作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

201レスポンス

作成済

ルート・スキーマ: 属性マッピングのADDResponse

型: object

ソースを表示

msgType(required): string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

RESTメッセージ・タイプ
searchResultEntries(required): array searchResultEntries
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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute Mapping SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

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

{
    "type":"array",
    "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"
    }
}

204レスポンス

コンテンツがありません

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

先頭に戻る