Creates and returns an OTP

POST 
/api/web/v1/otps

Create and return an OTP. Caller requires the OTPS:ADD permission.

Request

application/json

Body

required

applicationId stringrequired

Unique identifier of the Identity as a Service Authentication API application

clientIp string

Provided client IP address.

deliverOTP boolean

Whether to deliver the OTP. If not specified, this defaults to true.

otpDeliveryType string

Possible values: [EMAIL, SMS, VOICE]

Defines how a user receives their one-time passcode (Email, Text message (SMS), or Voice message (VOICE)).

returnOTP boolean

Whether to return the OTP. If not specified, this defaults to false.

transactionDetails

object[]

Defines transaction details to be associated with the OTP.

Array [

detail string

The transaction detail name.

usage string[]

Possible values: [RBA, TVS]

value string

The transaction detail value.

]

userId stringrequired

User ID (containing the user ID or a user alias) of the Identity as a Service user the OTP is being created for.

Responses

200

Successful

application/json

Schema

Schema

exp int64

The authorization token expiry time.

otp string

The OTP.

otpDeliveryType string

Possible values: [EMAIL, SMS, VOICE]

The OTP delivery type used. The value is null if OTP delivery was not performed

otpExpiryDate date-time

The OTP Expiry Date.

token string

The authorization token representing the OTP authentication challenge to complete.

Example (from schema)

{
  "exp": 0,
  "otp": "string",
  "otpDeliveryType": "EMAIL",
  "otpExpiryDate": "2019-02-19T13:17:27Z",
  "token": "string"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...