Oracle Access Managerでのパスワード・ポリシー管理REST API

テナントおよびpolicyidを使用したパスワード・ポリシーの取得

get

/iam/admin/access/api/v1/policy/PasswordPolicies/${tenantid}/${policyid}

PasswordPolicyは"OAM"パスワード・ポリシーについての情報を返します。レスポンスにはパスワード・ポリシー・ルールと、このパスワード・ポリシーが適用されるOAMユーザーのサブセットについての情報を提供する割当てルールが含まれます。

リクエスト

パス・パラメータ

policyid: string

パスワード・ポリシーの一意の識別子
tenantid: string

テナントの一意の識別子。

先頭に戻る

レスポンス

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

application/json

200 レスポンス

パスワード・ポリシーの割当て

ルート・スキーマ: schema

タイプ: array

ソースを表示

配列: オブジェクト PasswordPolicyAssignment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PasswordPolicyAssignment"
    }
}

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

タイプ: object

ソースを表示

AssignmentRule(optional): object assignmentRule
PasswordPolicyInfo(optional): object passwordPolicyInfo

{
    "type":"object",
    "properties":{
        "PasswordPolicyInfo":{
            "$ref":"#/definitions/passwordPolicyInfo"
        },
        "AssignmentRule":{
            "$ref":"#/definitions/assignmentRule"
        }
    }
}

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

タイプ: object

ソースを表示

idStoreRef(optional): string

現在のパスワード・ポリシーが割り当てられているアイデンティティ・ストア参照ID。
passwordPolicyID(optional): string

これは、passwordPolicyInfoのidで指定されているパスワード・ポリシーと一致している必要があります。
priority(optional): integer

このパスワード・ポリシー割当ての優先度。ユーザーのポリシーは、ユーザーが属するidstoreのすべての割当てルールを取得することにより確認され、優先度を使用してソートされます。それから、適用可能な最初のパスワード・ポリシーが、ユーザーに適用されるパスワード・ポリシーとして選択されます。
ruleType(optional): integer

ruletypeは、1-none 2 -groupのようなルールが指定された整数列挙です。
ruleValue(optional): string

ruleTypeがグループを示す場合、ruleValueはパスワード・ポリシーが適用されるためにユーザーが属している必要のあるグループを示します。

{
    "type":"object",
    "properties":{
        "idStoreRef":{
            "type":"string",
            "description":"The identity store reference id for which the current password policy is assigned to."
        },
        "priority":{
            "type":"integer",
            "description":"The priority for this password policy assignment. The policy for the user is ascertained by getting all the assignement rules for the idstore in which the user belongs, sorted using priority. The first applicable password policy is then chosen as the password policy applicable for the user."
        },
        "passwordPolicyID":{
            "type":"string",
            "description":"This has to match with the password policy specified in the passwordPolicyInfo id"
        },
        "ruleType":{
            "type":"integer",
            "description":"The ruletype is an integer enumerator which specifies the kind of rule 1-none 2 -group"
        },
        "ruleValue":{
            "type":"string",
            "description":"If the ruleType indicated group, then the rulevale indicates the group to which the user must belong to for the password policy to be applicable."
        }
    }
}

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

タイプ: object

ソースを表示

allAtOnce(optional): boolean

OAMではサポートされていません。ブール値。trueの場合、クライアントUIでは表示のたびにランダムな順番ですべてのチャレンジを表示します。falseの場合、クライアントUIでは一度に1つのチャレンジ質問が表示され、サブジェクトが答えると次の質問が表示されます。
challengePolicy(optional): integer

OAMではサポートされていません。チャレンジに関するポリシーを定義する複合属性。次のサブ属性が含まれます。source 次のいずれかを示す整数 + 0 - ユーザーによる定義。+ 1 - 管理者による定義。+ 2 - ユーザーおよび管理者による定義。
challengesEnabled(optional): boolean

OAMでは常にfalseです。チャレンジが認証時に使用可能であることを示すブール値。サポートされていません。OAMではユーザーのチャレンジ質問/回答をサポートしていないため、チャレンジ質問/回答関連のポリシー要素はいずれもサポートされていません。
defaultQuestions(optional): string

OAMではサポートされていません。チャレンジ質問を設定するときにサブジェクトが使用可能な、1つ以上のデフォルト質問を含む複数値文字列属性。OAMではサポートされていません
desc(optional): string

現在のポリシーを記述する文字列。通常は情報提供の目的で使用されます(ユーザーへの表示など)。
dictionaryLocation(optional): string

パスワード値に使用できない単語の辞書のURIを含む参照値。
disallowedChars(optional): string

パスワード値にどんな順序であっても使用できない文字のセットを示す文字列値。
disallowedSubStrings(optional): string

パスワード値に使用できない文字列のセットを示す複数値文字列。
expiresAfterDays(optional): integer

パスワードのリセットが必要となるまでの日数を示す整数。
firstNameDisallowed(optional): boolean

リソースの"name.givenName"に一致する文字のシーケンスがパスワードに含まれていてはいけないことを示すブール値。
id(optional): string

特定のパスワード・ポリシーを表す一意の識別子。
lastNameDisallowed(optional): boolean

リソースの"name.familyName"に一致する文字のシーケンスがパスワードに含まれていてはいけないことを示すブール値。
lockOutDuration(optional): integer

maxIncorrectAttemptsを超えた後にアカウントがロックされる分数を示す整数。
maxIncorrectAttempts(optional): integer

アカウントがロックされるまでの、失敗ログインの最大回数を表す整数。
maxIncorrectChallengesAttempts(optional): integer

OAMではサポートされていません。チャレンジの使用によるパスワード・リセット試行の最大失敗回数を表す整数。リセット試行においてチャレンジが間違っている場合、ユーザーのresetAttemptsカウンタに1が加えられます。resetAttemptsがmaxIncorrectAttemptsを超えるとサブジェクトのアカウントはロックされ、locked.reason値が設定されます。
maxLength(optional): integer

最大パスワード長を示す数値(文字数)。値が0または設定されていない場合は、最大長の制限なしになります。
maxRepeatedChars(optional): integer

パスワードの繰返し文字の最大数を示す整数。値が0または設定されていない場合は、制限なしになります。
maxSpecialChars(optional): integer

パスワードの特殊文字の最大数を示す整数。値が0または設定されていない場合は、最大長の制限なしになります。
minAlphaNumerals(optional): integer

パスワードの英数字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
minAlphas(optional): integer

パスワードの英字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
minAnswerCount(optional): integer

OAMではサポートされていません。パスワード忘れリクエストによるパスワード・リセットの試行時にサブジェクトが答える必要があるチャレンジ回答の最小数を示す整数。
minLength(optional): integer

最小パスワード長を示す整数(文字数)。値が0または設定されていない場合は、最小長の制限なしになります。
minLowerCase(optional): integer

パスワードの英小文字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
minNumerals(optional): integer

パスワードの数字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
minPasswordAgeInDays(optional): integer

パスワードが変更可能になるまでの最小日数を示す整数。
minQuestionCount(optional): integer

OAMではサポートされていません。チャレンジ質問の回答を設定する際にサブジェクトが答える必要があるチャレンジ質問の最小数を示す整数。値が0または設定されていない場合は、最小なしになります。サポートされていません
minResponseLength(optional): integer

OAMではサポートされていません。チャレンジ・レスポンスの文字の最小数を示す整数。値なしまたは0の場合は、最小長なしになります(実質的には1)。
minSpecialChars(optional): integer

パスワードの特殊文字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
minUnicodeChars(optional): integer

パスワードのunicode文字の最小数を示す整数。
minUniqueChars(optional): integer

パスワードの一意文字の最小数を示す整数。値が0または設定されていない場合は、最小制限なしになります。
minUpperCase(optional): integer

パスワードの英大文字の最小数を示す整数。値が0または設定されていない場合は、最小長の制限なしになります。
name(optional): string

ポリシーの名前の文字列。通常は情報提供の目的で使用されます(ユーザーへの表示など)
passwordHistorySize(optional): integer

履歴に保持されてパスワードとして使用できないパスワードの数を示す整数。
requiredChars(optional): string

パスワード値にどんな順序であってもよいので使用する必要がある文字のセットを示す文字列値。
startsWithAlpha(optional): boolean

パスワードを英字で開始する必要があることを示すブール値。
userNameDisallowed(optional): boolean

リソースの"userName"に一致する文字のシーケンスがパスワードに含まれていてはいけないことを示すブール値。
warningAfterDays(optional): integer

パスワードのリセットの警告が発行されるまでの日数を示す整数。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier representing a specific password policy."
        },
        "name":{
            "type":"string",
            "description":"A String that is the name of the policy.  Typically used for informational purposes (e.g. to display to the user)"
        },
        "desc":{
            "type":"string",
            "description":"A String that describes the current policy.  Typically used for informational purposes (e.g. to display to a user)."
        },
        "maxLength":{
            "type":"integer",
            "description":"An Integer indicating the maximum password length (in characters). A value of 0 or no value SHALL indicate no maximum length restriction."
        },
        "minLength":{
            "type":"integer",
            "description":"An Integer indicating the minimum password length (in characters). A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "minAlphas":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of alphabetic characters in a password.  A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "minNumerals":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of numeric characters in a password.  A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "minAlphaNumerals":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of alphabetic or numeric characters in a password.  A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "minSpecialChars":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of special characters in  a password.  A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "maxSpecialChars":{
            "type":"integer",
            "description":"An Integer indicating the maximum number of special characters in a password.  A value of 0 or no value SHALL indicate no maximum length restriction."
        },
        "minUpperCase":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of upper-case alphabetic characters in a password.  A value of 0 or no value SHALL indicate no minimum length restriction."
        },
        "minLowerCase":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of lower-case alphabetic characters in a password.  A value of 0 or no value SHALL indicateno minimum length restriction."
        },
        "minUniqueChars":{
            "type":"integer",
            "description":"An Integer indicating the minimum number of unique characters in a password.  A value of 0 or no value SHALL indicate no minimum restriction."
        },
        "maxRepeatedChars":{
            "type":"integer",
            "description":"An Integer indicating the maximum number of repeated characters in a password.  A value of 0 or no value SHALL indicate no restriction."
        },
        "startsWithAlpha":{
            "type":"boolean",
            "description":"A Boolean indicating that the password MUST being with an alphabetic character."
        },
        "minUnicodeChars":{
            "type":"integer",
            "description":"An integer indicating minimum number of unicode characters in a password."
        },
        "firstNameDisallowed":{
            "type":"boolean",
            "description":"A Boolean indicating a sequence of characters matching the resource's \"name.givenName\" SHALL NOT be included in the password."
        },
        "lastNameDisallowed":{
            "type":"boolean",
            "description":"A Boolean indicating a sequence of characters matching the resource's \"name.familyName\" SHALL NOT be included in the password."
        },
        "userNameDisallowed":{
            "type":"boolean",
            "description":"A Boolean indicating a sequence of characters matching the resource's \"userName\" SHALL NOT be included in the password."
        },
        "minPasswordAgeInDays":{
            "type":"integer",
            "description":"An Integer indicating the minimum age in days before the password can be changed."
        },
        "warningAfterDays":{
            "type":"integer",
            "description":"An Integer indicating the number of days after which a password reset warning will be issued."
        },
        "expiresAfterDays":{
            "type":"integer",
            "description":"An Integer indicating the numbers of days after which a password reset is required."
        },
        "requiredChars":{
            "type":"string",
            "description":"A String value whose contents indicates a set of characters that MUST appear, in any sequence, in a password value."
        },
        "disallowedChars":{
            "type":"string",
            "description":"A String value whose contents indicates a set of characters that SHALL NOT appear, in any sequence, in a password value."
        },
        "disallowedSubStrings":{
            "type":"string",
            "description":"A Multi-valued String indicating a set of Strings that SHALL NOT appear within a password value."
        },
        "dictionaryLocation":{
            "type":"string",
            "description":"A Reference value containing the URI of a dictionary of words not allowed to appear within a password value."
        },
        "passwordHistorySize":{
            "type":"integer",
            "description":"An Integer indicating the number of passwords that will be kept in history that may not be used as a password."
        },
        "maxIncorrectAttempts":{
            "type":"integer",
            "description":"An Integer representing the maximum number of failed logins before an account is locked."
        },
        "lockOutDuration":{
            "type":"integer",
            "description":"An Integer indicating the number of minutes an account will be locked after maxIncorrectAttempts exceeded."
        },
        "challengesEnabled":{
            "type":"boolean",
            "description":"Always false in OAM. A Boolean value indicating challenges MAY be used during authentication. Not supported. None of the challenge question/answers related policy elements are supported since OAM doesnt support user challenge questions/answers."
        },
        "challengePolicy":{
            "type":"integer",
            "description":"Not supported in OAM. A complex attribute that defines policy around challenges.  It contains the following sub-attributes.source  An Integer indicating one of the following +  0 - User Defined.  +  1 - Admin Defined. +  2 - User and Admin Defined."
        },
        "defaultQuestions":{
            "type":"string",
            "description":"Not supported in OAM. A Multi-valued String attribute that contains one or more default question a subject may use when setting their challenge questions.Not supported in OAM"
        },
        "minQuestionCount":{
            "type":"integer",
            "description":"Not supported in OAM. An Integer indicating the minimum number of challenge questions a subject MUST answer when setting challenge question answers.  A value of 0 or no value indicates no minimum.  Not supported"
        },
        "minAnswerCount":{
            "type":"integer",
            "description":"Not supported in OAM. An Integer indicating the minimum number of challenge answers a subject MUST answer when attempting to reset their password via forgot password request."
        },
        "allAtOnce":{
            "type":"boolean",
            "description":"Not supported in OAM. A Boolean value.  When true, the client UI will present all challengers in random order each time displayed.  When false, the client UI will present one challenge question at a time where the subject MUST respond before the next is displayed."
        },
        "minResponseLength":{
            "type":"integer",
            "description":"Not supported in OAM. An Integer indicating the minimum number of characters in a challenge response.  No value or a value of 0 indicates no minimum length (effectively 1)."
        },
        "maxIncorrectChallengesAttempts":{
            "type":"integer",
            "description":"Not supported in OAM. An Integer indicates the maximum number of failed reset password attempts using challenges.  If any challenges are wrong in a reset attempt, the users resetAttempts counter will be incremented by 1.  If resetAttempts is greater than maxIncorrectAttempts, the subject's account will be locked with a locked.reason value."
        }
    }
}

401 レスポンス

未許可

404 レスポンス

リクエスト・エンティティが見つからない

500 レスポンス

内部サーバー・エラー

先頭に戻る