ジャンプ先

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

UASチャレンジおよびファクトリ・ゲートウェイAPIからのレスポンスを集計する。また、必要に応じて、RESTベースになるファクタAPIをコールすることもできる。

post

/authn/v1

ユーザーが優先するチャレンジのリストを返します。また、ユーザーのチャレンジに使用できるファクタの数が1つであり、プロンプトも1つである場合、チャレンジ・プロセスを開始できます。また、パッシブ・ファクタ(ユーザーからの対話を必要としないファクタ)は、initの完了後に開始でき、これによってユーザーにチャレンジするリクエストが行われます。このようなファクタの例として、電子メールOTP、SMS OTP、TOTP、プッシュ通知などがあります。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ: schema

型: object

AuthnRequestには、チャレンジをフェッチして認証を初期化するためのユーザーおよびコンテキスト情報が含まれています

ソースの表示

• clientInfo(required): object ClientInfo
  コール元サービス・プロバイダに関する情報。
• context(required): object UserContext
  保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
• timeToLiveInSec: integer
  ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。デフォルトは300秒(5分)です
• userInfo: object UserInfo
  システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。

{
    "required":[
        "clientInfo",
        "context"
    ],
    "type":"object",
    "properties":{
        "userInfo":{
            "$ref":"#/components/schemas/UserInfo"
        },
        "clientInfo":{
            "$ref":"#/components/schemas/ClientInfo"
        },
        "context":{
            "$ref":"#/components/schemas/UserContext"
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated. Default to 300 seconds (5 Mins)"
        }
    },
    "description":"AuthnRequest contains user and context information to fetch challenges and initalize authn"
}

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

型: object

コール元サービス・プロバイダに関する情報。

ソースの表示

• clientId(required): string
  クライアントを一意に識別するクライアントの識別子
• clientSecret(required): string
  クライアントの検証に使用されるクライアント・シークレット
• ctype: string
  ユーザーとの対話に使用できるメカニズムに関する情報を提供します。

{
    "required":[
        "clientId",
        "clientSecret"
    ],
    "type":"object",
    "properties":{
        "ctype":{
            "type":"string",
            "description":"Provides the information regarding the mechanism available for user interaction."
        },
        "clientSecret":{
            "type":"string",
            "description":"client secret that is used to validate the client"
        },
        "clientId":{
            "type":"string",
            "description":"Identifier of the client that uniquely identify the client"
        }
    },
    "description":"Information about the calling service provider."
}

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

型: object

保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。

ソースの表示

• assuranceLevel: object assuranceLevel
  エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
• correlationId: string
  チャレンジAPIによって指定されたトランザクションID (以前にコールされた場合)。
• customContext(required): object CustomContext
  ユーザー・リクエストに存在する追加のコンテキスト。

{
    "required":[
        "customContext"
    ],
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api if called previously."
        },
        "assuranceLevel":{
            "type":"object",
            "description":"requested assurance level by the end user. The field needs to be populated by service provider based on the requested resource."
        },
        "customContext":{
            "$ref":"#/components/schemas/CustomContext"
        }
    },
    "description":"Additional context that can be provided by the caller while calling the preferecences API including assurance level, cookies, header, ip address, resource urls, user agents etc."
}

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

型: object

システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。

ソースの表示

• groups: array groups
  ユーザーが属するグループ。
• locale: string
  ユーザー・プリファレンスで優先ロケールを上書きするユーザーの現在のロケール。
• uniqueUserId: string
  外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
• userId(required): string
  UASシステム内のユーザーの一意の識別子。

{
    "required":[
        "userId"
    ],
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"The user unique identitifer in the UAS system."
        },
        "groups":{
            "type":"array",
            "description":"The groups that user belongs to.",
            "items":{
                "type":"string"
            }
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        },
        "locale":{
            "type":"string",
            "description":"The current locale of the user which will override preferred locale in user preference."
        }
    },
    "description":"User information provided by the caller to identify the user in the system. This is an optional parameter."
}

ネストされたスキーマ: 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。

{
    "required":[
        "ipAddr"
    ],
    "type":"object",
    "properties":{
        "userCookies":{
            "type":"array",
            "description":"Cookies present in the user access request.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "headers":{
            "type":"array",
            "description":"Headers, if any, present in the user access request. The content will be provided as input for rule execution.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "userAgent":{
            "type":"string",
            "description":"user-agent string from the user request"
        },
        "ipAddr":{
            "type":"string",
            "description":"incoming ip address"
        },
        "resource":{
            "type":"string",
            "description":"Resource requested by the user."
        },
        "ipforwarded":{
            "type":"string",
            "description":"x-Forwarded-for from the user environment"
        },
        "ldapgroup":{
            "type":"array",
            "description":"ldap groups of the user",
            "items":{
                "type":"string"
            }
        },
        "ldapattributes":{
            "type":"array",
            "description":"ldap atrributes of user",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "currentauthlevel":{
            "type":"integer",
            "description":"current authentication level of the user, if any at the time of making the challenge request."
        },
        "requestedauthlevel":{
            "type":"integer",
            "description":"requested authn level of the user"
        }
    },
    "description":"Additional context present in the user request."
}

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

型: array

ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"Headers, if any, present in the user access request. The content will be provided as input for rule execution.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: array

ユーザーのLDAP属性

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"ldap atrributes of user",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: array

ユーザーのLDAPグループ

ソースの表示

• Array of: string

{
    "type":"array",
    "description":"ldap groups of the user",
    "items":{
        "type":"string"
    }
}

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

型: array

ユーザー・アクセス・リクエストに存在するCookie。

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"Cookies present in the user access request.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: object

一般的に使用できるキーと値のペア。

ソースの表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): object value
  関連付けられた値。

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"associated value."
        }
    },
    "description":"Key-value pair which can be used generically."
}

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

型: object

関連付けられた値。

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

型: array

ユーザーが属するグループ。

ソースの表示

• Array of: string

{
    "type":"array",
    "description":"The groups that user belongs to.",
    "items":{
        "type":"string"
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

AuthnRequestには、チャレンジをフェッチして認証を初期化するためのユーザーおよびコンテキスト情報が含まれています

ソースの表示

• clientInfo(required): object ClientInfo
  コール元サービス・プロバイダに関する情報。
• context(required): object UserContext
  保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。
• timeToLiveInSec: integer
  ブロッキング・コールの開始時のブロッキング・コールの期間。期間の経過後、ブロッキング・コールが無効になります。デフォルトは300秒(5分)です
• userInfo: object UserInfo
  システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。

{
    "required":[
        "clientInfo",
        "context"
    ],
    "type":"object",
    "properties":{
        "userInfo":{
            "$ref":"#/components/schemas/UserInfo"
        },
        "clientInfo":{
            "$ref":"#/components/schemas/ClientInfo"
        },
        "context":{
            "$ref":"#/components/schemas/UserContext"
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated. Default to 300 seconds (5 Mins)"
        }
    },
    "description":"AuthnRequest contains user and context information to fetch challenges and initalize authn"
}

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

型: object

コール元サービス・プロバイダに関する情報。

ソースの表示

• clientId(required): string
  クライアントを一意に識別するクライアントの識別子
• clientSecret(required): string
  クライアントの検証に使用されるクライアント・シークレット
• ctype: string
  ユーザーとの対話に使用できるメカニズムに関する情報を提供します。

{
    "required":[
        "clientId",
        "clientSecret"
    ],
    "type":"object",
    "properties":{
        "ctype":{
            "type":"string",
            "description":"Provides the information regarding the mechanism available for user interaction."
        },
        "clientSecret":{
            "type":"string",
            "description":"client secret that is used to validate the client"
        },
        "clientId":{
            "type":"string",
            "description":"Identifier of the client that uniquely identify the client"
        }
    },
    "description":"Information about the calling service provider."
}

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

型: object

保証レベル、Cookie、ヘッダー、IPアドレス、リソースURL、ユーザー・エージェントなど、プリファレンスAPIをコール中にコール元が提供できる追加コンテキスト。

ソースの表示

• assuranceLevel: object assuranceLevel
  エンド・ユーザーがリクエストした保証レベル。このフィールドは、リクエストされたリソースに基づいてサービス・プロバイダによって移入される必要があります。
• correlationId: string
  チャレンジAPIによって指定されたトランザクションID (以前にコールされた場合)。
• customContext(required): object CustomContext
  ユーザー・リクエストに存在する追加のコンテキスト。

{
    "required":[
        "customContext"
    ],
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api if called previously."
        },
        "assuranceLevel":{
            "type":"object",
            "description":"requested assurance level by the end user. The field needs to be populated by service provider based on the requested resource."
        },
        "customContext":{
            "$ref":"#/components/schemas/CustomContext"
        }
    },
    "description":"Additional context that can be provided by the caller while calling the preferecences API including assurance level, cookies, header, ip address, resource urls, user agents etc."
}

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

型: object

システム内のユーザーを識別するためにコール元によって指定されるユーザー情報。これはオプションのパラメータです。

ソースの表示

• groups: array groups
  ユーザーが属するグループ。
• locale: string
  ユーザー・プリファレンスで優先ロケールを上書きするユーザーの現在のロケール。
• uniqueUserId: string
  外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
• userId(required): string
  UASシステム内のユーザーの一意の識別子。

{
    "required":[
        "userId"
    ],
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"The user unique identitifer in the UAS system."
        },
        "groups":{
            "type":"array",
            "description":"The groups that user belongs to.",
            "items":{
                "type":"string"
            }
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        },
        "locale":{
            "type":"string",
            "description":"The current locale of the user which will override preferred locale in user preference."
        }
    },
    "description":"User information provided by the caller to identify the user in the system. This is an optional parameter."
}

ネストされたスキーマ: 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。

{
    "required":[
        "ipAddr"
    ],
    "type":"object",
    "properties":{
        "userCookies":{
            "type":"array",
            "description":"Cookies present in the user access request.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "headers":{
            "type":"array",
            "description":"Headers, if any, present in the user access request. The content will be provided as input for rule execution.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "userAgent":{
            "type":"string",
            "description":"user-agent string from the user request"
        },
        "ipAddr":{
            "type":"string",
            "description":"incoming ip address"
        },
        "resource":{
            "type":"string",
            "description":"Resource requested by the user."
        },
        "ipforwarded":{
            "type":"string",
            "description":"x-Forwarded-for from the user environment"
        },
        "ldapgroup":{
            "type":"array",
            "description":"ldap groups of the user",
            "items":{
                "type":"string"
            }
        },
        "ldapattributes":{
            "type":"array",
            "description":"ldap atrributes of user",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        },
        "currentauthlevel":{
            "type":"integer",
            "description":"current authentication level of the user, if any at the time of making the challenge request."
        },
        "requestedauthlevel":{
            "type":"integer",
            "description":"requested authn level of the user"
        }
    },
    "description":"Additional context present in the user request."
}

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

型: array

ユーザー・アクセス・リクエストに存在するヘッダー(存在する場合)。コンテンツはルール実行の入力として提供されます。

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"Headers, if any, present in the user access request. The content will be provided as input for rule execution.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: array

ユーザーのLDAP属性

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"ldap atrributes of user",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: array

ユーザーのLDAPグループ

ソースの表示

• Array of: string

{
    "type":"array",
    "description":"ldap groups of the user",
    "items":{
        "type":"string"
    }
}

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

型: array

ユーザー・アクセス・リクエストに存在するCookie。

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"Cookies present in the user access request.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: object

一般的に使用できるキーと値のペア。

ソースの表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): object value
  関連付けられた値。

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"associated value."
        }
    },
    "description":"Key-value pair which can be used generically."
}

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

型: object

関連付けられた値。

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

型: array

ユーザーが属するグループ。

ソースの表示

• Array of: string

{
    "type":"array",
    "description":"The groups that user belongs to.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• 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
  アクセスがリクエストされたリソース。これは、ユーザーが認証され、これ以上のチャレンジが不要な場合にのみ返されます。

{
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api. Also this field contains previous id used within the session to update store."
        },
        "resource":{
            "type":"string",
            "description":"The resource for which the access was requested. This will be returned only when the user is authenticated and no further challenge is needed."
        },
        "apiResponse":{
            "$ref":"#/components/schemas/StatusInfo"
        },
        "challengeselectiontext":{
            "type":"string",
            "description":"Message to be displayed to select one of multiple challenges"
        },
        "challengeInfo":{
            "type":"array",
            "description":"A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.",
            "items":{
                "$ref":"#/components/schemas/FactorChallengeInfo"
            }
        },
        "nonce":{
            "type":"string",
            "description":"random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call."
        },
        "challengecontext":{
            "$ref":"#/components/schemas/InitContext"
        },
        "cookies":{
            "type":"array",
            "description":"Cookies present in the user access request.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    },
    "description":"The object describes the options available to end user for challenge otherwise also return the default challenge mechanism as per service provider."
}

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

型: object

フェッチ・チャレンジ情報リクエストのステータス。これには、ユーザー認証リクエストの処理に必要な情報が含まれています。

ソースの表示

• code: integer
  チャレンジ・ステータスを表すコード。
• message: string
  サーバーがリクエストを処理できない場合に生成されるエラー・メッセージ。
• status(required): string
  ユーザー・リクエストのフェッチ・チャレンジ情報のステータス。これは、authenticated/pending verification/pending identification/failed/error/missing registration/challenge blockedのいずれかになります。

{
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"Code representing the challenge status."
        },
        "status":{
            "type":"string",
            "description":"status of the fetch challenge info for user request. It will be one of the following authenticated/pending verification/pending identification/failed/error/missing registration/challenge blocked."
        },
        "message":{
            "type":"string",
            "description":"Error message generated if the server is unable to process the request."
        }
    },
    "description":"Status of the fetch challenge info request. It contains the information required to process the user authentication request."
}

ネストされたスキーマ: 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で修飾できます。

{
    "type":"object",
    "properties":{
        "factorKey":{
            "type":"string",
            "description":"the name of the factor that is selected by end user."
        },
        "successURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of successful challenge."
        },
        "failureURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge."
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated."
        },
        "factorAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserFactorAttribute"
            }
        },
        "requestParams":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair_2"
            }
        },
        "userId":{
            "type":"string",
            "description":"Unique identifier of the user. May be further qualified by groupId."
        },
        "groupId":{
            "type":"string",
            "description":"Group Id or app-name as applicable for user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

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

型: array

ユーザーは様々な方法でチャレンジできます。オブジェクトには、ユーザーが認証可能なすべての方法が含まれています。リクエストでユーザー情報を使用できない場合、サービス・プロバイダ構成に従ってデフォルトのチャレンジ・メカニズムが提供されます。

ソースの表示

• Array of: object FactorChallengeInfo
  使用可能なファクタを使用してユーザー・リクエストを処理するために必要な情報がオブジェクトに存在します。

{
    "type":"array",
    "description":"A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.",
    "items":{
        "$ref":"#/components/schemas/FactorChallengeInfo"
    }
}

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

型: array

ユーザー・アクセス・リクエストに存在するCookie。

ソースの表示

• 配列: object KeyValPair
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "description":"Cookies present in the user access request.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

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

型: array

ソースの表示

• Array of: object UserFactorAttribute
  エントリの配列として表されるマップ。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserFactorAttribute"
    }
}

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

型: array

ソースの表示

• Array of: object KeyValPair_2
  一般的に使用できるキーと値のペア。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair_2"
    }
}

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

型: object

エントリの配列として表されるマップ。

ソースの表示

• userAttributeName: string
  このユーザーのファクタ固有属性の名前。
• userAttributeValue: string
  このユーザーのファクタ固有属性の値。

{
    "required":[
        "userAttributeName|userAttributeValue"
    ],
    "type":"object",
    "properties":{
        "userAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute for this user."
        },
        "userAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute for this user."
        }
    },
    "description":"A map represented as an array of entries."
}

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

型: object

一般的に使用できるキーと値のペア。

ソースの表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): object value
  指定する必要があるコンテンツ。

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"Content that needs to be provided."
        }
    },
    "description":"Key-value pair which can be used generically."
}

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

型: object

指定する必要があるコンテンツ。

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

型: object

使用可能なファクタを使用してユーザー・リクエストを処理するために必要な情報がオブジェクトに存在します。

ソースの表示

• displayOrder(required): integer
  複数のファクタが存在する場合のユーザーへの表示順序
• factorContext(required): object FactorContext
  ユーザー認証リクエストを処理するためにファクタに必要なコンテキスト。
• factorKey: string
  登録に使用できるファクタのキー。
• factorName(required): string
  ファクタの名前
• factorUrl(required): string
  ファクタのURL

{
    "required":[
        "displayOrder",
        "factorContext",
        "factorName",
        "factorUrl"
    ],
    "type":"object",
    "properties":{
        "displayOrder":{
            "type":"integer",
            "description":"The order of display to user when multiple factors are present"
        },
        "factorUrl":{
            "type":"string",
            "description":"URL of the factor"
        },
        "factorName":{
            "type":"string",
            "description":"name of the factor"
        },
        "factorKey":{
            "type":"string",
            "description":"key of the factor that can be used for registration."
        },
        "factorContext":{
            "$ref":"#/components/schemas/FactorContext"
        }
    },
    "description":"information required to process user request using the factors available to it will be present in the object."
}

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

型: object

ユーザー認証リクエストを処理するためにファクタに必要なコンテキスト。

ソースの表示

• challengeAttrMap(required): array challengeAttrMap
• isSelected(required): boolean
  これがユーザー・プリファレンスに従って選択されたオプションかどうか。
• prompts(required): array prompts
  表示プロンプトには、ユーザーがさらに選択できる1つ以上のプロンプトが含まれます。
• promptselectmessage: string
  チャレンジ・プロンプトの1つを選択するためのメッセージ。

{
    "required":[
        "challengeAttrMap",
        "isSelected",
        "prompts"
    ],
    "type":"object",
    "properties":{
        "promptselectmessage":{
            "type":"string",
            "description":"Message to select one of the challenge prompts."
        },
        "prompts":{
            "type":"array",
            "description":"the display prompt will contain one or more prompts that can be further selected by user.",
            "items":{
                "$ref":"#/components/schemas/Prompt"
            }
        },
        "isSelected":{
            "type":"boolean",
            "description":"if this is the selected option as per the user preference."
        },
        "challengeAttrMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FactorAttribute"
            }
        }
    },
    "description":"The context required by factor to process the user authentication request."
}

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

型: array

ソースの表示

• Array of: object FactorAttribute
  エントリの配列として表されるマップ。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FactorAttribute"
    }
}

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

型: array

表示プロンプトには、ユーザーがさらに選択できる1つ以上のプロンプトが含まれます。

ソースの表示

• Array of: object Prompt
  エンド・ユーザーに表示できるプロンプト

{
    "type":"array",
    "description":"the display prompt will contain one or more prompts that can be further selected by user.",
    "items":{
        "$ref":"#/components/schemas/Prompt"
    }
}

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

型: object

エントリの配列として表されるマップ。

ソースの表示

• factorAttributeName: string
  ファクタ固有属性の名前。
• factorAttributeValue: string
  ファクタ固有属性の値。
• isValidated: boolean
  指定された属性が検証されているかどうか。一部の属性には検証が不要なため、このフィールドはオプションです。
• isVerified: boolean
  指定された属性が検証されているかどうか。一部の属性には検証が不要なため、このフィールドはオプションです。

{
    "type":"object",
    "properties":{
        "factorAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute."
        },
        "factorAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute."
        },
        "isVerified":{
            "type":"boolean",
            "description":"is the given attribute is verified. Some attributes does not require verification hence this field is optional."
        },
        "isValidated":{
            "type":"boolean",
            "description":"If the given attribute is validated. Some attributes do not require validation hence this field is optional."
        }
    },
    "description":"A map represented as an array of entries."
}

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

型: object

エンド・ユーザーに表示できるプロンプト

ソースの表示

• challengeText: string
  チャレンジ画面に表示されるメッセージ。
• name: string
  デバイスまたはプロンプトのわかりやすい名前。
• prompt: string
  マスクされたデバイス情報。
• prompttext: string
  選択のためにエンド・ユーザーに表示できるメッセージ文字列。
• requiredInputType: string
  none/text/radio/checkbox/textarea/waitingpageの列挙
• selected: boolean
  この特定のプロンプトが選択されているかどうか。
• validated: boolean
  プロンプトが検証されているかどうか
• verified: boolean
  プロンプトが検証されているかどうか

{
    "required":[
        "promptmessage"
    ],
    "type":"object",
    "properties":{
        "prompttext":{
            "type":"string",
            "description":"Message string that can be displayed to end user for selection."
        },
        "prompt":{
            "type":"string",
            "description":"Masked device info."
        },
        "challengeText":{
            "type":"string",
            "description":"Message to be displayed on the challenge screen."
        },
        "requiredInputType":{
            "type":"string",
            "description":"Enumeration of none/text/radio/checkbox/textarea/waitingpage"
        },
        "selected":{
            "type":"boolean",
            "description":"if this particular prompt is selected."
        },
        "name":{
            "type":"string",
            "description":"friendly name of the device or the prompt."
        },
        "verified":{
            "type":"boolean",
            "description":"if the prompt is verified"
        },
        "validated":{
            "type":"boolean",
            "description":"if the prompt is validated"
        }
    },
    "description":"Prompt the can be displayed to end user"
}

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

型: object

一般的に使用できるキーと値のペア。

ソースの表示

• key(required): string
  関連値のフェッチに使用できるキー。
• value(required): object value
  関連付けられた値。

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"associated value."
        }
    },
    "description":"Key-value pair which can be used generically."
}

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

型: object

関連付けられた値。

400レスポンス

パラメータの検証のために認証リクエストに失敗した場合。

本文()

ルート・スキーマ: AuthnAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

先頭に戻る