チャレンジ表示情報
get
/oam/services/rest/auth/api/v1/mfa/challengeDisplayInfo
チャレンジで使用されるユーザー属性の表示情報を取得します。
リクエスト
サポートされているメディア・タイプ
- application/json
- application/xml
問合せパラメータ
- appName: string
チャレンジ表示情報をリクエストするアプリケーションのアプリ名
- challengeType(optional): string
チャレンジ表示情報を返すためのチャレンジのタイプ
- userId: string
チャレンジ表示情報を取得するためのユーザーのユーザーID。
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200 レスポンス
成功
ルート・スキーマ : ChallengeDisplayResponse
型:
ソースを表示
object
- challengeInfoList: array challengeInfoList
チャレンジ情報オブジェクトの配列。
- message: string
エラーを説明するメッセージ(存在する場合)。
- minorCode: string
エラー詳細を示すマイナー・コード。
- resultCode: string
成功(0)またはエラーを示すレスポンス・コード。
ネストされたスキーマ : ChallengeInfo
型:
ソースを表示
object
- challengeType: string
この部分の情報に関連付けられているチャレンジのタイプ(sms|email|...)
- contact: string
チャレンジ・タイプに関連付けられている電子メール/電話番号。
- prompt: string
チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。
401 レスポンス
未認可
404 レスポンス
リクエスト・エンティティが見つからない
422 レスポンス
処理不能なエンティティ
ルート・スキーマ : ChallengeDisplayResponse
型:
ソースを表示
object
- challengeInfoList: array challengeInfoList
チャレンジ情報オブジェクトの配列。
- message: string
エラーを説明するメッセージ(存在する場合)。
- minorCode: string
エラー詳細を示すマイナー・コード。
- resultCode: string
成功(0)またはエラーを示すレスポンス・コード。
ネストされたスキーマ : ChallengeInfo
型:
ソースを表示
object
- challengeType: string
この部分の情報に関連付けられているチャレンジのタイプ(sms|email|...)
- contact: string
チャレンジ・タイプに関連付けられている電子メール/電話番号。
- prompt: string
チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。
500 レスポンス
内部サーバー・エラー
ルート・スキーマ : ChallengeDisplayResponse
型:
ソースを表示
object
- challengeInfoList: array challengeInfoList
チャレンジ情報オブジェクトの配列。
- message: string
エラーを説明するメッセージ(存在する場合)。
- minorCode: string
エラー詳細を示すマイナー・コード。
- resultCode: string
成功(0)またはエラーを示すレスポンス・コード。
ネストされたスキーマ : ChallengeInfo
型:
ソースを表示
object
- challengeType: string
この部分の情報に関連付けられているチャレンジのタイプ(sms|email|...)
- contact: string
チャレンジ・タイプに関連付けられている電子メール/電話番号。
- prompt: string
チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。
デフォルト・レスポンス
予期しないエラー
ルート・スキーマ : ChallengeDisplayResponse
型:
ソースを表示
object
- challengeInfoList: array challengeInfoList
チャレンジ情報オブジェクトの配列。
- message: string
エラーを説明するメッセージ(存在する場合)。
- minorCode: string
エラー詳細を示すマイナー・コード。
- resultCode: string
成功(0)またはエラーを示すレスポンス・コード。
ネストされたスキーマ : ChallengeInfo
型:
ソースを表示
object
- challengeType: string
この部分の情報に関連付けられているチャレンジのタイプ(sms|email|...)
- contact: string
チャレンジ・タイプに関連付けられている電子メール/電話番号。
- prompt: string
チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。
例
この例では、チャレンジで使用されるユーザー属性の情報を取得する方法を示します。
cURLの例
curl -X GET \
'http://hostname:port/oam/services/rest/auth/api/v1/mfa/challengeDisplayInfo?userId=weblogic&appName=TestApp' \
-H 'authorization: Basic d2VibG9naWM6d2VsY29tZTE=' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
リクエスト本文の例
次の例では、レスポンス本文のコンテンツを示しています。
{ "resultCode": "0", "challengeInfoList": [ { "prompt": "da*******@******.com", "challengeType": "email" } , { "prompt": "1********55", "challengeType": "sms" } ] }