REST API for Multifactor Authentication One Time PIN in Oracle Access Manager

Challenge Display Information

get

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

Get display information for user attributes used in challenges.

Request

Supported Media Types

application/json
application/xml

Query Parameters

appName(required): string

App name for application requesting challenge display information
challengeType: string

Types of challenge to return challenge display information for
idStore: string

Identity Store Reference to find supplied user.
userId(required): string

User ID of user to get challenge display information for.

Response

Supported Media Types

application/json
application/xml

200 Response

Success

Root Schema : ChallengeDisplayResponse

Type: object

Show Source

challengeInfoList: array challengeInfoList

Array of challenge info objects.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error details.
resultCode: string

Response code indicating success (0) or error.

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

Nested Schema : challengeInfoList

Type: array

Array of challenge info objects.

Show Source

Array of: object ChallengeInfo

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

Nested Schema : ChallengeInfo

Type: object

Show Source

challengeType: string

Type of challenge associated with this piece of information (sms|email|totp|...)
contact: string

Email/phone number associated with the challenge type.
prompt: string

Display string for challenge information. Eg. Masked email/phone number. Masking based on configuration.

{
    "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 Response

Unauthorized

404 Response

Requested entity not found

422 Response

Unprocessable Entity

Root Schema : ChallengeDisplayResponse

Type: object

Show Source

challengeInfoList: array challengeInfoList

Array of challenge info objects.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error details.
resultCode: string

Response code indicating success (0) or error.

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

Nested Schema : challengeInfoList

Type: array

Array of challenge info objects.

Show Source

Array of: object ChallengeInfo

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

Nested Schema : ChallengeInfo

Type: object

Show Source

challengeType: string

Type of challenge associated with this piece of information (sms|email|totp|...)
contact: string

Email/phone number associated with the challenge type.
prompt: string

Display string for challenge information. Eg. Masked email/phone number. Masking based on configuration.

{
    "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 Response

Internal Server Error

Root Schema : ChallengeDisplayResponse

Type: object

Show Source

challengeInfoList: array challengeInfoList

Array of challenge info objects.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error details.
resultCode: string

Response code indicating success (0) or error.

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

Nested Schema : challengeInfoList

Type: array

Array of challenge info objects.

Show Source

Array of: object ChallengeInfo

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

Nested Schema : ChallengeInfo

Type: object

Show Source

challengeType: string

Type of challenge associated with this piece of information (sms|email|totp|...)
contact: string

Email/phone number associated with the challenge type.
prompt: string

Display string for challenge information. Eg. Masked email/phone number. Masking based on configuration.

{
    "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."
        }
    }
}

Default Response

Unexpected error

Root Schema : ChallengeDisplayResponse

Type: object

Show Source

challengeInfoList: array challengeInfoList

Array of challenge info objects.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error details.
resultCode: string

Response code indicating success (0) or error.

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

Nested Schema : challengeInfoList

Type: array

Array of challenge info objects.

Show Source

Array of: object ChallengeInfo

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

Nested Schema : ChallengeInfo

Type: object

Show Source

challengeType: string

Type of challenge associated with this piece of information (sms|email|totp|...)
contact: string

Email/phone number associated with the challenge type.
prompt: string

Display string for challenge information. Eg. Masked email/phone number. Masking based on configuration.

{
    "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."
        }
    }
}

Examples

This example demonstrates the method to get information for user attributes used in challenges.

Example of the Response Headers

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' \

Example of the Response Body

The following example shows the contents of the response body.

{
"resultCode": "0",
"challengeInfoList": [
{ "prompt": "da*******@******.com", "challengeType": "email" }
,

{ "prompt": "1********55", "challengeType": "sms" }
]
}