ジャンプ先

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

OTPおよびuseridとidstorerefを使用したPasswordReset

投稿

/oam/services/rest/access/api/v1/pswdmanagement/PasswordResetRequestsWithOTP/${userid}/${idstoreref}

認証されたWebアプリケーションでは、OTPを生成する別のREST APIコールでユーザーに生成されたOTPを使用して、ユーザーのリセットするパスワードを更新できます。ValidateOTPRequestオブジェクトには、OTPを検証する必要な情報が含まれます。これらの情報は、ユーザーのOTPを生成するRESTコールから取得できます。パス・パラメータuseridおよびidstorerefを使用して、OAMのユーザーを一意に識別します。

リクエスト

パス・パラメータ

• idstoreref: string
  ユーザーが属するidstore
• userid: string
  ユーザーを一意に識別する入力

問合せパラメータ

• userdetails(optional): string
  問合せパラメータのuserdetailsオブジェクト

本文()

リクエスト・オブジェクト

ルート・スキーマ: PasswordResetRequestWithOTPRequest

型: object

ソースを表示

• otp(optional): object ValidateOTPRequest
• password(optional): string
  ユーザー・パスワード
• username(optional): object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "password":{
            "type":"string",
            "description":"User password"
        },
        "otp":{
            "$ref":"#/definitions/ValidateOTPRequest"
        }
    }
}

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

型: object

ソースを表示

• appName: string
  呼出し側アプリケーションを定義する名前。
• correlationId: string
  createOTP APIが返すCorrelationId。
• otpCode: string
  検証するユーザーが入力したOTPコード。
• sessionId(optional): string
  OTP生成に関連付けられているSessionId。
• userId: string
  OTPコードを生成するユーザーのユーザー名。

{
    "type":"object",
    "required":[
        "userId",
        "correlationId",
        "otpCode",
        "appName"
    ],
    "properties":{
        "userId":{
            "description":"Username of user to generate OTP code for.",
            "type":"string"
        },
        "correlationId":{
            "description":"CorrelationId returned by createOTP api.",
            "type":"string"
        },
        "otpCode":{
            "description":"User entered otp code to be validated.",
            "type":"string"
        },
        "appName":{
            "description":"Name defining calling app.",
            "type":"string"
        },
        "sessionId":{
            "description":"SessionId associated with OTP generation.",
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• dn(optional): string
  アイデンティティ・ストア内のユーザーの識別名
• idstoreref(optional): string
  ユーザーが属するidstore
• tenantname(optional): string
  テナント名。常にsystemTenantです
• username(optional): string
  ユーザーの短縮名

{
    "type":"object",
    "properties":{
        "tenantname":{
            "type":"string",
            "description":"tenant name. Its always systemTenant"
        },
        "idstoreref":{
            "type":"string",
            "description":"idstore that the user belongs to"
        },
        "dn":{
            "type":"string",
            "description":"the distinguished name of the user in the identity store"
        },
        "username":{
            "type":"string",
            "description":"the short name of the user"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

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

本文()

ルート・スキーマ: PasswordResetWithOTPResponse

型: object

ソースを表示

• isValid(optional): boolean
• messages(optional): array messages
• validateOTPResponse(optional): object ValidateOTPResponse

{
    "type":"object",
    "properties":{
        "isValid":{
            "type":"boolean"
        },
        "messages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyMessage"
            }
        },
        "validateOTPResponse":{
            "$ref":"#/definitions/ValidateOTPResponse"
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト PolicyMessage

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

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

型: object

ソースを表示

• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  エラー詳細を示すマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Respose code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

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

型: object

ソースを表示

• displayValue(optional): string
• resourceBundleKey(optional): string

{
    "properties":{
        "resourceBundleKey":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        }
    }
}

401 レスポンス

未認可

404 レスポンス

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

500 レスポンス

内部サーバー・エラー

先頭に戻る