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

Generates OTP

post

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

Generate OTP code for provided user, stores the OTP code for validation, and send using provided delivery channel. Must also be called before validating a TOTP code, in order to generate a valid correlationId. Configuration details can be found in OAM Admin Guide - Configuring the Adaptive Authentication Plug-in in the Oracle Access Management Console

Request

Supported Media Types

application/json
application/xml

Create OTP request

Root Schema : CreateOTPRequest

Type: object

Show Source

appName(required): string

Name defining calling app.
deliveryChannel(required): string

Channel to deliver OTP to user. (sms|email|totp|custom)
email: string

Email address of user to use for delivery of OTP code.
idStore: string

Identity Store Reference to find supplied user.
phone: string

Phone number of user to use for delivery of OTP code.
sessionId: string

SessionId associated with OTP generation.
userId(required): string

Username of user to generate OTP code for.

{
    "type":"object",
    "required":[
        "userId",
        "appName",
        "deliveryChannel"
    ],
    "properties":{
        "userId":{
            "description":"Username of user to generate OTP code for.",
            "type":"string"
        },
        "appName":{
            "description":"Name defining calling app.",
            "type":"string"
        },
        "deliveryChannel":{
            "description":"Channel to deliver OTP to user. (sms|email|totp|custom)",
            "type":"string"
        },
        "email":{
            "description":"Email address of user to use for delivery of OTP code.",
            "type":"string"
        },
        "phone":{
            "description":"Phone number of user to use for delivery of OTP code.",
            "type":"string"
        },
        "sessionId":{
            "description":"SessionId associated with OTP generation.",
            "type":"string"
        },
        "idStore":{
            "description":"Identity Store Reference to find supplied user.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Successful

Root Schema : CreateOTPResponse

Type: object

Show Source

correlationId: string

Unique identifier for generated OTP code.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error or containing OTP code if delivery channel was "custom".
resultCode: string

Response code indicating success (0) or error.

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

422 Response

Unprocessable Entity

Root Schema : CreateOTPResponse

Type: object

Show Source

correlationId: string

Unique identifier for generated OTP code.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error or containing OTP code if delivery channel was "custom".
resultCode: string

Response code indicating success (0) or error.

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

424 Response

Failed Dependency

Root Schema : CreateOTPResponse

Type: object

Show Source

correlationId: string

Unique identifier for generated OTP code.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error or containing OTP code if delivery channel was "custom".
resultCode: string

Response code indicating success (0) or error.

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

500 Response

Internal Server Error

Root Schema : CreateOTPResponse

Type: object

Show Source

correlationId: string

Unique identifier for generated OTP code.
message: string

Message describing error, if any.
minorCode: string

Minor code indicating error or containing OTP code if delivery channel was "custom".
resultCode: string

Response code indicating success (0) or error.

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Response code indicating success (0) or error."
        },
        "correlationId":{
            "type":"string",
            "description":"Unique identifier for generated OTP code."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error or containing OTP code if delivery channel was \"custom\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}