ジャンプ先

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

DNによるパスワード・ポリシーの変更

PATCH

/rest/v1/admin/{dn}

DNによるパスワード・ポリシーの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるパスワード・ポリシー

ルート・スキーマ: 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制御。

ソースを表示

• [0]: string

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

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

型: array

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

ソースを表示

• [0]: object 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

更新する属性値。

ソースを表示

• [0]: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: パスワード・ポリシーの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/Password Policy SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object パスワード・ポリシーのSearchResultEntry

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

ネストされたスキーマ: パスワード・ポリシーのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-account-status-notification-handler(optional): array ds-cfg-account-status-notification-handler
  関連するパスワード記憶スキームで使用するアカウント・ステータス通知ハンドラの名前を指定します。
• ds-cfg-allow-expired-password-changes(optional): boolean
  デフォルト値: false

  パスワードの有効期限が切れたユーザーに、パスワード変更拡張操作を使用してそのパスワードを変更することを引き続き許可するかどうかを示します。
• ds-cfg-allow-multiple-password-values(optional): boolean
  デフォルト値: false

  ユーザー・エントリがパスワード属性について異なる値を複数持つことができるかどうかを示します。
• ds-cfg-allow-pre-encoded-passwords(optional): boolean
  デフォルト値: false

  ユーザーが、事前にエンコードされた値を指定することによってパスワードを変更できるかどうかを示します。
• ds-cfg-allow-user-password-changes(optional): boolean
  デフォルト値: true

  ユーザーが自分のパスワードを変更できるかどうかを示します。
• ds-cfg-default-password-storage-scheme: array ds-cfg-default-password-storage-scheme
  このパスワード・ポリシーでクリア・テキスト・パスワードのエンコードに使用するパスワード記憶スキームの名前を指定します。
• ds-cfg-deprecated-password-storage-scheme(optional): array ds-cfg-deprecated-password-storage-scheme
  このパスワード・ポリシーで非推奨とみなすパスワード記憶スキームの名前を指定します。
• ds-cfg-expire-passwords-without-warning(optional): boolean
  デフォルト値: false

  有効期限の警告通知がユーザーに表示されたことがなくても、ディレクトリ・サーバーでユーザーのパスワードを有効期限切れにすることができるかどうかを示します。
• ds-cfg-force-change-on-add(optional): boolean
  デフォルト値: false

  アカウントが作成された後、ディレクトリ・サーバーに対する最初の認証時にパスワードの変更をユーザーに強制するかどうかを示します。
• ds-cfg-force-change-on-reset(optional): boolean
  デフォルト値: false

  管理者によってパスワードがリセットされた場合にパスワードの変更をユーザーに強制するかどうかを示します。
• ds-cfg-grace-login-count(optional): integer(int32)
  デフォルト値: 0

  アカウントの有効期限が切れた後、ユーザーが新しいパスワードを選択できるようにそのユーザーに許可する猶予ログインの回数を指定します。
• ds-cfg-idle-lockout-interval(optional): string
  デフォルト値: 0 seconds

  関連するユーザーがロックアウトされるまでにアカウントがアイドル状態を維持できる(つまり、そのユーザーがサーバーに対して認証を行わない)最大時間を指定します。
• ds-cfg-last-login-time-attribute(optional): string
  関連するパスワード・ポリシーを持つユーザーの最終ログイン時刻の保持に使用する属性タイプの名前またはOIDを指定します。
• ds-cfg-last-login-time-format(optional): string
  関連するパスワード・ポリシーを持つユーザーの最終ログイン時刻値の生成に使用する書式文字列を指定します。
• ds-cfg-lockout-duration(optional): string
  デフォルト値: 0 seconds

  何度も認証に失敗した後にアカウントをロック状態にする時間の長さを指定します。
• ds-cfg-lockout-failure-count(optional): integer(int32)
  デフォルト値: 0

  アカウントがロックアウトされるまでにユーザーに許可される認証の失敗の最大数を指定します。
• ds-cfg-lockout-failure-expiration-interval(optional): string
  デフォルト値: 0 seconds

  アカウントのロックアウトを目的としてユーザーに対して認証の失敗が加算されなくなるまでの時間の長さを指定します。
• ds-cfg-lockout-soft-duration(optional): string
  デフォルト値: 0 seconds

  多数の認証失敗が発生した後に、ユーザー・アカウントを一時的にロックする時間の長さを指定します。
• ds-cfg-lockout-soft-failure-count(optional): integer(int32)
  デフォルト値: 0

  ユーザー・アカウントを一時的にロックするまでに、ユーザーが認証に何回まで失敗が許されるかを指定します。
• ds-cfg-max-password-age(optional): string
  デフォルト値: 0 seconds

  変更の必要が生じるまでにユーザーが同じパスワードを継続して使用できる最大時間(つまり、パスワードが有効期限切れになるまでの間隔)を指定します。
• ds-cfg-max-password-reset-age(optional): string
  デフォルト値: 0 seconds

  管理者によってパスワードがリセットされてから、ユーザーがロックされた状態になるまでにパスワードを変更する必要がある最大時間を指定します。
• ds-cfg-min-password-age(optional): string
  デフォルト値: 0 seconds

  パスワードの変更後にユーザーが再びパスワードを変更できるようになるまでの最小時間を指定します。
• ds-cfg-password-attribute: string
  ユーザー・パスワードの保持に使用する属性タイプを指定します。
• ds-cfg-password-change-requires-current-password(optional): boolean
  デフォルト値: false

  ユーザー・パスワードの変更でパスワード変更拡張操作を使用する必要があるかどうかと、変更を許可する前にユーザーの現在のパスワードを入力する必要があるかどうかを示します。
• ds-cfg-password-expiration-warning-interval(optional): string
  デフォルト値: 5 days

  サーバーがユーザーのバインド・レスポンスへの警告通知の挿入を開始する、そのユーザーのパスワードが実際に有効期限切れになるまでの最大時間を指定します。
• ds-cfg-password-generator(optional): string
  関連するパスワード・ポリシーで使用するパスワード・ジェネレータの名前を指定します。
• ds-cfg-password-history-count(optional): integer(int32)
  デフォルト値: 0

  パスワード履歴に保持する、以前のパスワードの最大数を指定します。
• ds-cfg-password-history-duration(optional): string
  デフォルト値: 0 seconds

  パスワードがパスワード履歴に保持される最大時間を指定します。
• ds-cfg-password-validator(optional): array ds-cfg-password-validator
  関連するパスワード記憶スキームで使用するパスワード・バリデータの名前を指定します。
• ds-cfg-previous-last-login-time-attribute(optional): string
  関連するパスワード・ポリシーを持つユーザーの最終ログイン時刻以外のものの保持に使用する属性タイプの名前またはOIDを指定します。
• ds-cfg-previous-last-login-time-format(optional): array ds-cfg-previous-last-login-time-format
  パスワード・ポリシーに関連付けられているユーザーについて過去の任意の時点で最終ログイン時刻に使用された可能性がある書式文字列を指定します。
• ds-cfg-require-change-by-time(optional): string
  関連するパスワード・ポリシーを持つすべてのユーザーがパスワードを変更する必要がある時刻を指定します。
• ds-cfg-require-secure-authentication(optional): boolean
  デフォルト値: false

  関連するパスワード・ポリシーを持つユーザーが安全な方法で認証を行う必要があるかどうかを示します。
• ds-cfg-require-secure-password-changes(optional): boolean
  デフォルト値: false

  関連するパスワード・ポリシーを持つユーザーが、資格証明を公開しない安全な方法でパスワードを変更する必要があるかどうかを示します。
• ds-cfg-skip-validation-for-administrators(optional): boolean
  デフォルト値: false

  管理者によって設定されたパスワードについて、ユーザー・パスワードの変更に必要なパスワード検証プロセスを省略できるかどうかを示します。
• ds-cfg-state-update-failure-policy(optional): string
  デフォルト値: reactive

  指定可能な値: [ "ignore", "proactive", "reactive" ]

  認証の試行中にパスワード・ポリシー状態情報を更新できない場合のサーバーの対処方法を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-default-password-storage-scheme",
        "ds-cfg-password-attribute"
    ],
    "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-min-password-age":{
            "description":"Specifies the minimum length of time after a password change before the user is allowed to change the password again. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-require-change-by-time":{
            "description":"Specifies the time by which all users with the associated password policy must change their passwords. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-password-validator":{
            "description":"Specifies the names of the password validators that are used with the associated password storage scheme. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-password-generator":{
            "description":"Specifies the name of the password generator that is used with the associated password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-password-history-count":{
            "description":"Specifies the maximum number of former passwords to maintain in the password history. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-default-password-storage-scheme":{
            "description":"Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allow-expired-password-changes":{
            "description":"Indicates whether a user whose password is expired is still allowed to change that password using the password modify extended operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-lockout-duration":{
            "description":"Specifies the length of time that an account is locked after too many authentication failures. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-lockout-soft-failure-count":{
            "description":"Specifies the maximum number of authentication failures that a user is allowed before the account is locked temporarily. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allow-pre-encoded-passwords":{
            "description":"Indicates whether users can change their passwords by providing a pre-encoded value. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-password-change-requires-current-password":{
            "description":"Indicates whether user password changes must use the password modify extended operation and must include the user's current password before the change is allowed. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allow-multiple-password-values":{
            "description":"Indicates whether user entries can have multiple distinct values for the password attribute. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-max-password-reset-age":{
            "description":"Specifies the maximum length of time that users have to change passwords after they have been reset by an administrator before they become locked. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-skip-validation-for-administrators":{
            "description":"Indicates whether passwords set by administrators are allowed to bypass the password validation process that is required for user password changes. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-last-login-time-attribute":{
            "description":"Specifies the name or OID of the attribute type that is used to hold the last login time for users with the associated password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-require-secure-password-changes":{
            "description":"Indicates whether users with the associated password policy are required to change their password in a secure manner that does not expose the credentials. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-require-secure-authentication":{
            "description":"Indicates whether users with the associated password policy are required to authenticate in a secure manner. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-state-update-failure-policy":{
            "description":"Specifies how the server deals with the inability to update password policy state information during an authentication attempt. ",
            "readOnly":false,
            "default":"reactive",
            "type":"string",
            "enum":[
                "ignore",
                "proactive",
                "reactive"
            ]
        },
        "ds-cfg-grace-login-count":{
            "description":"Specifies the number of grace logins that a user is allowed after the account has expired to allow that user to choose a new password. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-lockout-failure-expiration-interval":{
            "description":"Specifies the length of time before an authentication failure is no longer counted against a user for the purposes of account lockout. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-password-expiration-warning-interval":{
            "description":"Specifies the maximum length of time before a user's password actually expires that the server begins to include warning notifications in bind responses for that user. ",
            "readOnly":false,
            "default":"5 days",
            "type":"string"
        },
        "ds-cfg-allow-user-password-changes":{
            "description":"Indicates whether users can change their own passwords. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-force-change-on-reset":{
            "description":"Indicates whether users are forced to change their passwords if they are reset by an administrator. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-lockout-failure-count":{
            "description":"Specifies the maximum number of authentication failures that a user is allowed before the account is locked out. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-password-history-duration":{
            "description":"Specifies the maximum length of time that passwords remain in the password history. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-lockout-soft-duration":{
            "description":"Specifies the length of time that an account is temporarily locked after too many authentication failures. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-expire-passwords-without-warning":{
            "description":"Indicates whether the Directory Server allows a user's password to expire even if that user has never seen an expiration warning notification. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-max-password-age":{
            "description":"Specifies the maximum length of time that a user can continue using the same password before it must be changed (that is, the password expiration interval). ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-last-login-time-format":{
            "description":"Specifies the format string that is used to generate the last login time value for users with the associated password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-previous-last-login-time-format":{
            "description":"Specifies the format string(s) that might have been used with the last login time at any point in the past for users associated with the password policy. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-deprecated-password-storage-scheme":{
            "description":"Specifies the names of the password storage schemes that are considered deprecated for this password policy. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-previous-last-login-time-attribute":{
            "description":"Specifies the name or OID of the attribute type that is used to hold the one but last login time for users with the associated password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-account-status-notification-handler":{
            "description":"Specifies the names of the account status notification handlers that are used with the associated password storage scheme. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-idle-lockout-interval":{
            "description":"Specifies the maximum length of time that an account may remain idle (that is, the associated user does not authenticate to the server) before that user is locked out. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the attribute type used to hold user passwords. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-force-change-on-add":{
            "description":"Indicates whether users are forced to change their passwords upon first authenticating to the Directory Server after their account has been created. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-account-status-notification-handler

型: array

関連するパスワード記憶スキームで使用するアカウント・ステータス通知ハンドラの名前を指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the names of the account status notification handlers that are used with the associated password storage scheme. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-default-password-storage-scheme

型: array

このパスワード・ポリシーでクリア・テキスト・パスワードのエンコードに使用するパスワード記憶スキームの名前を指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-deprecated-password-storage-scheme

型: array

このパスワード・ポリシーで非推奨とみなすパスワード記憶スキームの名前を指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the names of the password storage schemes that are considered deprecated for this password policy. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-password-validator

型: array

関連するパスワード記憶スキームで使用するパスワード・バリデータの名前を指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the names of the password validators that are used with the associated password storage scheme. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-previous-last-login-time-format

型: array

パスワード・ポリシーに関連付けられているユーザーについて過去の任意の時点で最終ログイン時刻に使用された可能性がある書式文字列を指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the format string(s) that might have been used with the last login time at any point in the past for users associated with the password policy. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

先頭に戻る