UASチャレンジおよびファクトリ・ゲートウェイAPIからのレスポンスを集計する。また、必要に応じて、RESTベースになるファクタAPIをコールすることもできる。
post
/authn/v1
ユーザーが優先するチャレンジのリストを返します。また、ユーザーのチャレンジに使用できるファクタの数が1つであり、プロンプトも1つである場合、チャレンジ・プロセスを開始できます。また、パッシブ・ファクタ(ユーザーからの対話を必要としないファクタ)は、initの完了後に開始でき、これによってユーザーにチャレンジするリクエストが行われます。このようなファクタの例として、電子メールOTP、SMS OTP、TOTP、プッシュ通知などがあります。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/xml
- application/json
ルート・スキーマ: schema
型:
object
AuthnRequestには、チャレンジをフェッチして認証を初期化するためのユーザーおよびコンテキスト情報が含まれています
ソースの表示
-
clientInfo(required): object ClientInfo
コール元サービス・プロバイダに関する情報。
-
context(required): object UserContext
保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
-
timeToLiveInSec: integer
ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。デフォルトは300秒(5分)です
-
userInfo: object UserInfo
システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。
ネストされたスキーマ: ClientInfo
型:
object
コール元サービス・プロバイダに関する情報。
ソースの表示
-
clientId(required): string
クライアントを一意に識別するクライアントの識別子
-
clientSecret(required): string
クライアントの検証に使用されるクライアント・シークレット
-
ctype: string
ユーザーとの対話に使用できるメカニズムに関する情報を提供します。
ネストされたスキーマ: UserContext
型:
object
保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
ソースの表示
-
assuranceLevel: object assuranceLevel
エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
-
correlationId: string
チャレンジAPIによって指定されたトランザクションID (以前にコールされた場合)。
-
customContext(required): object CustomContext
ユーザー・リクエストに存在する追加のコンテキスト。
ネストされたスキーマ: UserInfo
型:
object
システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。
ソースの表示
-
groups: array groups
ユーザーが属するグループ。
-
locale: string
ユーザー・プリファレンスで優先ロケールを上書きするユーザーの現在のロケール。
-
uniqueUserId: string
外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
-
userId(required): string
UASシステム内のユーザーの一意の識別子。
ネストされたスキーマ: assuranceLevel
型:
object
エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
ネストされたスキーマ: CustomContext
型:
object
ユーザー・リクエストに存在する追加のコンテキスト。
ソースの表示
-
currentauthlevel: integer
チャレンジ・リクエストを行う時点でのユーザーの現在の認証レベル(存在する場合)。
-
headers: array headers
ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。
-
ipAddr(required): string
受信IPアドレス
-
ipforwarded: string
ユーザー環境からのx-Forwarded-for
-
ldapattributes: array ldapattributes
ユーザーのLDAP属性
-
ldapgroup: array ldapgroup
ユーザーのLDAPグループ
-
requestedauthlevel: integer
リクエストされたユーザーの認証レベル
-
resource: string
ユーザーによってリクエストされたリソース。
-
userAgent: string
ユーザー・リクエストからのユーザー・エージェント文字列
-
userCookies: array userCookies
ユーザー・アクセス・リクエストに存在するCookie。
ネストされたスキーマ: headers
型:
array
ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。
ソースの表示
- 配列: object KeyValPair
一般的に使用できるキーと値のペア。
ネストされたスキーマ: userCookies
型:
array
ユーザー・アクセス・リクエストに存在するCookie。
ソースの表示
- 配列: object KeyValPair
一般的に使用できるキーと値のペア。
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースの表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): object value
関連付けられた値。
ネストされたスキーマ: value
型:
object
関連付けられた値。
ルート・スキーマ: schema
型:
object
AuthnRequestには、チャレンジをフェッチして認証を初期化するためのユーザーおよびコンテキスト情報が含まれています
ソースの表示
-
clientInfo(required): object ClientInfo
コール元サービス・プロバイダに関する情報。
-
context(required): object UserContext
保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
-
timeToLiveInSec: integer
ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。デフォルトは300秒(5分)です
-
userInfo: object UserInfo
システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。
ネストされたスキーマ: ClientInfo
型:
object
コール元サービス・プロバイダに関する情報。
ソースの表示
-
clientId(required): string
クライアントを一意に識別するクライアントの識別子
-
clientSecret(required): string
クライアントの検証に使用されるクライアント・シークレット
-
ctype: string
ユーザーとの対話に使用できるメカニズムに関する情報を提供します。
ネストされたスキーマ: UserContext
型:
object
保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
ソースの表示
-
assuranceLevel: object assuranceLevel
エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
-
correlationId: string
チャレンジAPIによって指定されたトランザクションID (以前にコールされた場合)。
-
customContext(required): object CustomContext
ユーザー・リクエストに存在する追加のコンテキスト。
ネストされたスキーマ: UserInfo
型:
object
システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。
ソースの表示
-
groups: array groups
ユーザーが属するグループ。
-
locale: string
ユーザー・プリファレンスで優先ロケールを上書きするユーザーの現在のロケール。
-
uniqueUserId: string
外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
-
userId(required): string
UASシステム内のユーザーの一意の識別子。
ネストされたスキーマ: assuranceLevel
型:
object
エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
ネストされたスキーマ: CustomContext
型:
object
ユーザー・リクエストに存在する追加のコンテキスト。
ソースの表示
-
currentauthlevel: integer
チャレンジ・リクエストを行う時点でのユーザーの現在の認証レベル(存在する場合)。
-
headers: array headers
ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。
-
ipAddr(required): string
受信IPアドレス
-
ipforwarded: string
ユーザー環境からのx-Forwarded-for
-
ldapattributes: array ldapattributes
ユーザーのLDAP属性
-
ldapgroup: array ldapgroup
ユーザーのLDAPグループ
-
requestedauthlevel: integer
リクエストされたユーザーの認証レベル
-
resource: string
ユーザーによってリクエストされたリソース。
-
userAgent: string
ユーザー・リクエストからのユーザー・エージェント文字列
-
userCookies: array userCookies
ユーザー・アクセス・リクエストに存在するCookie。
ネストされたスキーマ: headers
型:
array
ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。
ソースの表示
- 配列: object KeyValPair
一般的に使用できるキーと値のペア。
ネストされたスキーマ: userCookies
型:
array
ユーザー・アクセス・リクエストに存在するCookie。
ソースの表示
- 配列: object KeyValPair
一般的に使用できるキーと値のペア。
ネストされたスキーマ: KeyValPair
型:
object
一般的に使用できるキーと値のペア。
ソースの表示
-
key(required): string
関連値のフェッチに使用できるキー。
-
value(required): object value
関連付けられた値。
ネストされたスキーマ: value
型:
object
関連付けられた値。
レスポンス
サポートされているメディア・タイプ
- application/xml
- application/json
200レスポンス
成功
ルート・スキーマ: AuthnResponse
型:
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が期待されます。
-
resource: string
アクセスがリクエストされたリソース。これは、ユーザーが認証され、これ以上のチャレンジが不要な場合にのみ返されます。
ネストされたスキーマ: 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レスポンス
パラメータの検証のために認証リクエストに失敗した場合。