Jump to

• Request
• Response

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. 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

Body ()

Create OTP request

Root Schema : CreateOTPRequest

Type: object

Show Source

• appName: string
  Name defining calling app.
• deliveryChannel: string
  Channel to deliver OTP to user.
• email: string
  Email address of user to use for delivery of OTP code.
• phone: string
  Phone number of user to use for delivery of OTP code.
• sessionId: string
  SessionId associated with OTP generation.
• userId: 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.",
            "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"
        }
    }
}

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful

Body ()

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 type was "none".
• 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 type was \"none\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

422 Response

Unprocessable Entity

Body ()

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 type was "none".
• 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 type was \"none\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

424 Response

Failed Dependency

Body ()

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 type was "none".
• 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 type was \"none\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

500 Response

Internal Server Error

Body ()

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 type was "none".
• 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 type was \"none\"."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}