ジャンプ先

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

チャレンジ表示情報

get

/oam/services/rest/auth/api/v1/mfa/challengeDisplayInfo

チャレンジで使用されるユーザー属性の表示情報を取得します。

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• appName: string
  チャレンジ表示情報をリクエストするアプリケーションのアプリ名
• challengeType(optional): string
  チャレンジ表示情報を返すためのチャレンジのタイプ
• idStore(optional): string
  指定されたユーザーを検索するアイデンティティ・ストア参照。
• userId: string
  チャレンジ表示情報を取得するためのユーザーのユーザーID。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

成功

本文()

ルート・スキーマ : ChallengeDisplayResponse

型: object

ソースを表示

• challengeInfoList(optional): array challengeInfoList
  チャレンジ情報オブジェクトの配列。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  エラー詳細を示すマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        },
        "challengeInfoList":{
            "description":"Array of challenge info objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChallengeInfo"
            }
        }
    }
}

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

タイプ: array

チャレンジ情報オブジェクトの配列。

ソースを表示

• 配列: オブジェクト ChallengeInfo

{
    "description":"Array of challenge info objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChallengeInfo"
    }
}

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

型: object

ソースを表示

• challengeType(optional): string
  この部分の情報に関連付けられているチャレンジのタイプ(sms|email|totp|...)
• contact(optional): string
  チャレンジ・タイプに関連付けられている電子メール/電話番号。
• prompt(optional): string
  チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。

{
    "type":"object",
    "properties":{
        "challengeType":{
            "type":"string",
            "description":"Type of challenge associated with this piece of information (sms|email|totp|...)"
        },
        "prompt":{
            "type":"string",
            "description":"Display string for challenge information.  Eg. Masked email/phone number.  Masking based on configuration."
        },
        "contact":{
            "type":"string",
            "description":"Email/phone number associated with the challenge type."
        }
    }
}

401 レスポンス

未認可

404 レスポンス

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

422 レスポンス

処理不能なエンティティ

本文()

ルート・スキーマ : ChallengeDisplayResponse

型: object

ソースを表示

• challengeInfoList(optional): array challengeInfoList
  チャレンジ情報オブジェクトの配列。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  エラー詳細を示すマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        },
        "challengeInfoList":{
            "description":"Array of challenge info objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChallengeInfo"
            }
        }
    }
}

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

タイプ: array

チャレンジ情報オブジェクトの配列。

ソースを表示

• 配列: オブジェクト ChallengeInfo

{
    "description":"Array of challenge info objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChallengeInfo"
    }
}

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

型: object

ソースを表示

• challengeType(optional): string
  この部分の情報に関連付けられているチャレンジのタイプ(sms|email|totp|...)
• contact(optional): string
  チャレンジ・タイプに関連付けられている電子メール/電話番号。
• prompt(optional): string
  チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。

{
    "type":"object",
    "properties":{
        "challengeType":{
            "type":"string",
            "description":"Type of challenge associated with this piece of information (sms|email|totp|...)"
        },
        "prompt":{
            "type":"string",
            "description":"Display string for challenge information.  Eg. Masked email/phone number.  Masking based on configuration."
        },
        "contact":{
            "type":"string",
            "description":"Email/phone number associated with the challenge type."
        }
    }
}

500 レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ : ChallengeDisplayResponse

型: object

ソースを表示

• challengeInfoList(optional): array challengeInfoList
  チャレンジ情報オブジェクトの配列。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  エラー詳細を示すマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        },
        "challengeInfoList":{
            "description":"Array of challenge info objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChallengeInfo"
            }
        }
    }
}

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

タイプ: array

チャレンジ情報オブジェクトの配列。

ソースを表示

• 配列: オブジェクト ChallengeInfo

{
    "description":"Array of challenge info objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChallengeInfo"
    }
}

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

型: object

ソースを表示

• challengeType(optional): string
  この部分の情報に関連付けられているチャレンジのタイプ(sms|email|totp|...)
• contact(optional): string
  チャレンジ・タイプに関連付けられている電子メール/電話番号。
• prompt(optional): string
  チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。

{
    "type":"object",
    "properties":{
        "challengeType":{
            "type":"string",
            "description":"Type of challenge associated with this piece of information (sms|email|totp|...)"
        },
        "prompt":{
            "type":"string",
            "description":"Display string for challenge information.  Eg. Masked email/phone number.  Masking based on configuration."
        },
        "contact":{
            "type":"string",
            "description":"Email/phone number associated with the challenge type."
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ : ChallengeDisplayResponse

型: object

ソースを表示

• challengeInfoList(optional): array challengeInfoList
  チャレンジ情報オブジェクトの配列。
• message(optional): string
  エラーを説明するメッセージ(存在する場合)。
• minorCode(optional): string
  エラー詳細を示すマイナー・コード。
• resultCode(optional): string
  成功(0)またはエラーを示すレスポンス・コード。

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        },
        "challengeInfoList":{
            "description":"Array of challenge info objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChallengeInfo"
            }
        }
    }
}

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

タイプ: array

チャレンジ情報オブジェクトの配列。

ソースを表示

• 配列: オブジェクト ChallengeInfo

{
    "description":"Array of challenge info objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChallengeInfo"
    }
}

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

型: object

ソースを表示

• challengeType(optional): string
  この部分の情報に関連付けられているチャレンジのタイプ(sms|email|totp|...)
• contact(optional): string
  チャレンジ・タイプに関連付けられている電子メール/電話番号。
• prompt(optional): string
  チャレンジ情報の表示文字列。例:マスキングされた電子メール/電話番号。構成に基づいたマスキング。

{
    "type":"object",
    "properties":{
        "challengeType":{
            "type":"string",
            "description":"Type of challenge associated with this piece of information (sms|email|totp|...)"
        },
        "prompt":{
            "type":"string",
            "description":"Display string for challenge information.  Eg. Masked email/phone number.  Masking based on configuration."
        },
        "contact":{
            "type":"string",
            "description":"Email/phone number associated with the challenge type."
        }
    }
}

先頭に戻る

例

この例では、チャレンジで使用されるユーザー属性の情報を取得する方法を示します。

レスポンス・ヘッダーの例

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" }
]
}

先頭に戻る