initチャレンジからのレスポンスを取得し、チャレンジおよびチャレンジAPIを確定して、ユーザーがさらにチャレンジされる必要があるかどうかを識別する。
put
/authn/v1
UAS内の認証ステータスを更新します。また、ユーザーにさらにチャレンジが必要な場合にも返されます(ユーザーの成功を返すこともできます)。内部的にvalidateをコールして、パッシブなファクタで渡されたパラメータを検証できます。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/xml
- application/json
ルート・スキーマ: schema
型:
object
オブジェクトは、認証リクエストの更新のリクエスト・パラメータを定義します。
ソースの表示
-
challengeAnswer: string
ファクタに渡す、ユーザーが指定した回答。
-
challengedata: object InitChallengeData
チャレンジ・ファクタに対するユーザーおよびユーザーの登録に関する情報。
-
challengeop(required): string
チャレンジAPIで実行するようにリクエストされた操作。Init/Validate/Finalizeのいずれかです。initの場合、nonceはオプションです。Validate/Finalizeの場合は、nonceが必要です。
-
challengeResult: string
チャレンジの結果。Success/Error/Failureのいずれか。検証の結果、パッシブ・ファクタAPIが呼び出され、ChallengeAnswerが検証されます。ファクタがパッシブでない場合は、例外がスローされます。他の結果は、チャレンジ・コールを確定するために直接渡されます。
-
challengeResultReason: string
チャレンジ結果が失敗した場合の理由。wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedoutのいずれかです。
-
correlationId(required): string
チャレンジAPIによって提供されるトランザクションID。また、このフィールドには、ストアを更新するためにセッション内で使用された以前のIDも含まれます。
-
nonce: string
将来のリクエストを識別するランダムな文字列。これは応答ごとに変化し、確定コールでは最新のnonceが期待されます。
ネストされたスキーマ: InitChallengeData
型:
object
チャレンジ・ファクタに対するユーザーおよびユーザーの登録に関する情報。
ソースの表示
-
abandonedChallenge: boolean
このチャレンジがユーザーによって破棄されたかどうかを示すフラグ。
-
correlationId: string
このチャレンジの相関ID。ファクタ実装では、finishChallengeコール中にSP/UASへのコールバックでこれを使用する必要があります。
-
factorAttributes: array factorAttributes
-
factorKey: string
エンド・ユーザーによって選択されたファクタの名前。
-
failureURL: string
チャレンジが失敗した場合にフローをリダイレクトする必要があるリソース。ほとんどの場合、これはfinalizerChallengeのURLになります。
-
groupId: string
ユーザーに適用可能なグループIDまたはアプリケーション名。
-
isRetry: boolean
これが再試行かどうか。
-
successURL: string
チャレンジが成功した場合にフローをリダイレクトする必要があるリソース。
-
timeToLiveInSec: integer
ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。
-
uniqueUserId: string
外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
-
userId: string
ユーザーの一意の識別子。さらにgroupIdで修飾できます。
ネストされたスキーマ: factorAttributes
型:
ソースの表示
array
- Array of: object UserFactorAttribute
エントリの配列として表されるマップ。
ネストされたスキーマ: UserFactorAttribute
型:
object
エントリの配列として表されるマップ。
ソースの表示
-
userAttributeName: string
このユーザーのファクタ固有属性の名前。
-
userAttributeValue: string
このユーザーのファクタ固有属性の値。
ルート・スキーマ: schema
型:
object
オブジェクトは、認証リクエストの更新のリクエスト・パラメータを定義します。
ソースの表示
-
challengeAnswer: string
ファクタに渡す、ユーザーが指定した回答。
-
challengedata: object InitChallengeData
チャレンジ・ファクタに対するユーザーおよびユーザーの登録に関する情報。
-
challengeop(required): string
チャレンジAPIで実行するようにリクエストされた操作。Init/Validate/Finalizeのいずれかです。initの場合、nonceはオプションです。Validate/Finalizeの場合は、nonceが必要です。
-
challengeResult: string
チャレンジの結果。Success/Error/Failureのいずれか。検証の結果、パッシブ・ファクタAPIが呼び出され、ChallengeAnswerが検証されます。ファクタがパッシブでない場合は、例外がスローされます。他の結果は、チャレンジ・コールを確定するために直接渡されます。
-
challengeResultReason: string
チャレンジ結果が失敗した場合の理由。wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedoutのいずれかです。
-
correlationId(required): string
チャレンジAPIによって提供されるトランザクションID。また、このフィールドには、ストアを更新するためにセッション内で使用された以前のIDも含まれます。
-
nonce: string
将来のリクエストを識別するランダムな文字列。これは応答ごとに変化し、確定コールでは最新のnonceが期待されます。
ネストされたスキーマ: InitChallengeData
型:
object
チャレンジ・ファクタに対するユーザーおよびユーザーの登録に関する情報。
ソースの表示
-
abandonedChallenge: boolean
このチャレンジがユーザーによって破棄されたかどうかを示すフラグ。
-
correlationId: string
このチャレンジの相関ID。ファクタ実装では、finishChallengeコール中にSP/UASへのコールバックでこれを使用する必要があります。
-
factorAttributes: array factorAttributes
-
factorKey: string
エンド・ユーザーによって選択されたファクタの名前。
-
failureURL: string
チャレンジが失敗した場合にフローをリダイレクトする必要があるリソース。ほとんどの場合、これはfinalizerChallengeのURLになります。
-
groupId: string
ユーザーに適用可能なグループIDまたはアプリケーション名。
-
isRetry: boolean
これが再試行かどうか。
-
successURL: string
チャレンジが成功した場合にフローをリダイレクトする必要があるリソース。
-
timeToLiveInSec: integer
ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。
-
uniqueUserId: string
外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
-
userId: string
ユーザーの一意の識別子。さらにgroupIdで修飾できます。
ネストされたスキーマ: factorAttributes
型:
ソースの表示
array
- Array of: object UserFactorAttribute
エントリの配列として表されるマップ。
ネストされたスキーマ: UserFactorAttribute
型:
object
エントリの配列として表されるマップ。
ソースの表示
-
userAttributeName: string
このユーザーのファクタ固有属性の名前。
-
userAttributeValue: string
このユーザーのファクタ固有属性の値。
レスポンス
サポートされているメディア・タイプ
- application/xml
- application/json
200レスポンス
成功
ルート・スキーマ: UpdateAuthnResponse
型:
object
更新レスポンス・オブジェクト。
ソースの表示
-
apiResponse: object StatusInfo
フェッチ・チャレンジ情報リクエストのステータス。これには、ユーザー認証リクエストの処理に必要な情報が含まれています。
-
challengecontext: object InitContext
-
challengeInfo: array challengeInfo
ユーザーは様々な方法でチャレンジできます。オブジェクトには、ユーザーが認証可能なすべての方法が含まれています。リクエストでユーザー情報を使用できない場合、サービス・プロバイダ構成に従ってデフォルトのチャレンジ・メカニズムが提供されます。
-
challengeselectiontext: string
複数のチャレンジのうち1つを選択するために表示するメッセージ
-
cookies: array cookies
ユーザー・アクセス・リクエストに存在するCookie。
-
correlationId: string
チャレンジAPIによって提供されるトランザクションID。また、このフィールドには、ストアを更新するためにセッション内で使用された以前のIDも含まれます。
-
nonce: string
将来のリクエストを識別するランダムな文字列。これは応答ごとに変化し、確定コールでは最新のnonceが期待されます。
ネストされたスキーマ: StatusInfo
型:
object
フェッチ・チャレンジ情報リクエストのステータス。これには、ユーザー認証リクエストの処理に必要な情報が含まれています。
ソースの表示
-
code: integer
チャレンジ・ステータスを表すコード。
-
message: string
サーバーがリクエストを処理できない場合に生成されるエラー・メッセージ。
-
status(required): string
ユーザー・リクエストのフェッチ・チャレンジ情報のステータス。これは、authenticated/pending verification/pending identification/failed/error/missing registration/challenge blockedのいずれかになります。
ネストされたスキーマ: InitContext
型:
ソースの表示
object
-
factorAttributes: array factorAttributes
-
factorKey: string
エンド・ユーザーによって選択されたファクタの名前。
-
failureURL: string
チャレンジが失敗した場合にフローをリダイレクトする必要があるリソース。ほとんどの場合、これはfinalizerChallengeのURLになります。
-
groupId: string
ユーザーに適用可能なグループIDまたはアプリケーション名。
-
requestParams: array requestParams
-
successURL: string
チャレンジが成功した場合にフローをリダイレクトする必要があるリソース。
-
timeToLiveInSec: integer
ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。
-
uniqueUserId: string
外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
-
userId: string
ユーザーの一意の識別子。さらにgroupIdで修飾できます。
ネストされたスキーマ: challengeInfo
型:
array
ユーザーは様々な方法でチャレンジできます。オブジェクトには、ユーザーが認証可能なすべての方法が含まれています。リクエストでユーザー情報を使用できない場合、サービス・プロバイダ構成に従ってデフォルトのチャレンジ・メカニズムが提供されます。
ソースの表示
- Array of: object FactorChallengeInfo
使用可能なファクタを使用してユーザー・リクエストを処理するために必要な情報がオブジェクトに存在します。
ネストされたスキーマ: factorAttributes
型:
ソースの表示
array
- Array of: object UserFactorAttribute
エントリの配列として表されるマップ。
ネストされたスキーマ: UserFactorAttribute
型:
object
エントリの配列として表されるマップ。
ソースの表示
-
userAttributeName: string
このユーザーのファクタ固有属性の名前。
-
userAttributeValue: string
このユーザーのファクタ固有属性の値。
ネストされたスキーマ: KeyValPair_2
型:
object
一般的に使用できるキーと値のペア。
ソースの表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): object value
指定する必要があるコンテンツ。
ネストされたスキーマ: value
型:
object
指定する必要があるコンテンツ。
ネストされたスキーマ: FactorChallengeInfo
型:
object
使用可能なファクタを使用してユーザー・リクエストを処理するために必要な情報がオブジェクトに存在します。
ソースの表示
-
displayOrder(required): integer
複数のファクタが存在する場合のユーザーへの表示順序
-
factorContext(required): object FactorContext
ユーザー認証リクエストを処理するためにファクタに必要なコンテキスト。
-
factorKey: string
登録に使用できるファクタのキー。
-
factorName(required): string
ファクタの名前
-
factorUrl(required): string
ファクタのURL
ネストされたスキーマ: FactorContext
型:
object
ユーザー認証リクエストを処理するためにファクタに必要なコンテキスト。
ソースの表示
-
challengeAttrMap(required): array challengeAttrMap
-
isSelected(required): boolean
これがユーザー・プリファレンスに従って選択されたオプションかどうか。
-
prompts(required): array prompts
表示プロンプトには、ユーザーがさらに選択できる1つ以上のプロンプトが含まれます。
-
promptselectmessage: string
チャレンジ・プロンプトの1つを選択するためのメッセージ。
ネストされたスキーマ: prompts
型:
array
表示プロンプトには、ユーザーがさらに選択できる1つ以上のプロンプトが含まれます。
ソースの表示
- Array of: object Prompt
エンド・ユーザーに表示できるプロンプト
ネストされたスキーマ: FactorAttribute
型:
object
エントリの配列として表されるマップ。
ソースの表示
-
factorAttributeName: string
ファクタ固有属性の名前。
-
factorAttributeValue: string
ファクタ固有属性の値。
-
isValidated: boolean
指定された属性が検証されているかどうか。一部の属性には検証が不要なため、このフィールドはオプションです。
-
isVerified: boolean
指定された属性が検証されているかどうか。一部の属性には検証が不要なため、このフィールドはオプションです。
ネストされたスキーマ: Prompt
型:
object
エンド・ユーザーに表示できるプロンプト
ソースの表示
-
challengeText: string
チャレンジ画面に表示されるメッセージ。
-
name: string
デバイスまたはプロンプトのわかりやすい名前。
-
prompt: string
マスクされたデバイス情報。
-
prompttext: string
選択のためにエンド・ユーザーに表示できるメッセージ文字列。
-
requiredInputType: string
none/text/radio/checkbox/textarea/waitingpageの列挙
-
selected: boolean
この特定のプロンプトが選択されているかどうか。
-
validated: boolean
プロンプトが検証されているかどうか
-
verified: boolean
プロンプトが検証されているかどうか
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースの表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): object value
関連付けられた値。
ネストされたスキーマ: value
型:
object
関連付けられた値。
400レスポンス
パラメータの検証のために更新認証に失敗した場合。