Oracle Unified Directoryの管理REST API: 文字セット・パスワード・バリデータの追加、検索、比較または削除

文字セット・パスワード・バリデータの追加、検索、比較または削除

POST

/rest/v1/admin

文字セット・パスワード・バリデータの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要がある文字セット・パスワード・バリデータ

ルート・スキーマ: 文字セット・パスワード・バリデータのPOSTRequest

型: object

ソースを表示

assertion(optional): string

LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes(optional): object 文字セット・パスワード・バリデータのプロパティ
base(optional): string

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

LDAP操作のためにサーバーに送信するLDAP制御。
dn(optional): 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(optional): string

LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
msgType: 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(optional): array requiredAttributes

エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
scope(optional): 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/Character Set Password Validator 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(optional): string

エントリのCN (共通名)
ds-cfg-allow-unclassified-characters: boolean

このパスワード・バリデータで、パスワードにユーザー定義文字セット以外の文字を含めることができるかどうかを示します。
ds-cfg-character-set: array ds-cfg-character-set

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。
ds-cfg-enabled: boolean

パスワード・バリデータが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.extensions.CharacterSetPasswordValidator

パスワード・バリデータの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-use-any-of(optional): integer(int32)

デフォルト値: -1

パスワードで文字を使用する必要がある文字セットの最小数。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-character-set",
        "ds-cfg-allow-unclassified-characters",
        "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 password validator implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.CharacterSetPasswordValidator",
            "type":"string"
        },
        "ds-cfg-character-set":{
            "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-use-any-of":{
            "description":"Minimum number of character sets from which the password must include characters. ",
            "readOnly":false,
            "default":-1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allow-unclassified-characters":{
            "description":"Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the password validator is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: string

{
    "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である場合)にのみ使用します。

ソースを表示

[0]: string

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

ネストされたスキーマ: ds-cfg-character-set

型: array

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 文字セット・パスワード・バリデータのSuccessResponse

型: object

ソースを表示

compareResult(optional): boolean

LDAP比較操作の結果を示します。
msgType: 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: array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults: 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/Character Set Password Validator SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: object 文字セット・パスワード・バリデータのSearchResultEntry

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

ネストされたスキーマ: 文字セット・パスワード・バリデータのSearchResultEntry

型: object

ソースを表示

attributes: object 文字セット・パスワード・バリデータのプロパティ
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/Character Set Password Validator Properties"
        }
    }
}

ネストされたスキーマ: 文字セット・パスワード・バリデータのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-allow-unclassified-characters: boolean

このパスワード・バリデータで、パスワードにユーザー定義文字セット以外の文字を含めることができるかどうかを示します。
ds-cfg-character-set: array ds-cfg-character-set

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。
ds-cfg-enabled: boolean

パスワード・バリデータが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.extensions.CharacterSetPasswordValidator

パスワード・バリデータの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-use-any-of(optional): integer(int32)

デフォルト値: -1

パスワードで文字を使用する必要がある文字セットの最小数。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-character-set",
        "ds-cfg-allow-unclassified-characters",
        "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 password validator implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.CharacterSetPasswordValidator",
            "type":"string"
        },
        "ds-cfg-character-set":{
            "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-use-any-of":{
            "description":"Minimum number of character sets from which the password must include characters. ",
            "readOnly":false,
            "default":-1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allow-unclassified-characters":{
            "description":"Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the password validator is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-character-set

型: array

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

201レスポンス

作成済

ルート・スキーマ: 文字セット・パスワード・バリデータのADDResponse

型: object

ソースを表示

msgType: string

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

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

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

型: array

ソースを表示

[0]: object 文字セット・パスワード・バリデータのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Character Set Password Validator SearchResultEntry"
    }
}

ネストされたスキーマ: 文字セット・パスワード・バリデータのSearchResultEntry

型: object

ソースを表示

attributes: object 文字セット・パスワード・バリデータのプロパティ
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/Character Set Password Validator Properties"
        }
    }
}

ネストされたスキーマ: 文字セット・パスワード・バリデータのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-allow-unclassified-characters: boolean

このパスワード・バリデータで、パスワードにユーザー定義文字セット以外の文字を含めることができるかどうかを示します。
ds-cfg-character-set: array ds-cfg-character-set

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。
ds-cfg-enabled: boolean

パスワード・バリデータが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.extensions.CharacterSetPasswordValidator

パスワード・バリデータの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-use-any-of(optional): integer(int32)

デフォルト値: -1

パスワードで文字を使用する必要がある文字セットの最小数。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-character-set",
        "ds-cfg-allow-unclassified-characters",
        "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 password validator implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.CharacterSetPasswordValidator",
            "type":"string"
        },
        "ds-cfg-character-set":{
            "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-use-any-of":{
            "description":"Minimum number of character sets from which the password must include characters. ",
            "readOnly":false,
            "default":-1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allow-unclassified-characters":{
            "description":"Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the password validator is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-character-set

型: array

パスワードを構成できる文字を含む文字セット、およびその文字セットから選択する必要がある最小文字数を示す値を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

204レスポンス

コンテンツがありません

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

先頭に戻る