otp-items
Operations addressed under /otp-items — 10 operations.
aurax-bff-redirect-get-otp-confirm-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-otp-confirm-by-transaction-id; this entry declares none of its own.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_12 | 400 | OTP_TRANSACTION_ALREADY_CONFIRMED |
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND |
ERR_OTP_8 | 400 | OTP_HAS_EXPIRED |
ERR_OTP_9 | 400 | OTP_IS_INVALID |
path Parameters
transactionIdquery Parameters
oneTimePasswordaurax-bff-redirect-get-otp-confirm-by-transaction-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-otp-item-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<OtpItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
KeyFormatId | Guid | no |
Name | string | no |
ValidityDuration | int? | yes |
RetryDuration | int? | yes |
IsActive | bool | no |
RetryCount | int | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-otp-item-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-otp-retry-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-otp-retry-by-transaction-id; this entry declares none of its own.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND |
path Parameters
transactionIdaurax-bff-redirect-get-otp-retry-by-transaction-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-otp-item-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as OtpItemDto.
| Field | Declared type | Nullable |
|---|---|---|
KeyFormatId | Guid | no |
Name | string | no |
ValidityDuration | int? | yes |
RetryDuration | int? | yes |
IsActive | bool | no |
RetryCount | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-otp-item-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-otp-item-edit-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-otp-item-edit-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-otp-item-delete-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-otp-item-delete-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-confirm-otp-by-transaction-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target confirm-otp-by-transaction-id; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_12 | 400 | OTP_TRANSACTION_ALREADY_CONFIRMED |
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND |
ERR_OTP_8 | 400 | OTP_HAS_EXPIRED |
ERR_OTP_9 | 400 | OTP_IS_INVALID |
path Parameters
idtransactionIdaurax-bff-redirect-confirm-otp-by-transaction-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
isConfirmedphoneNumberaurax-bff-redirect-confirm-otp-retry-by-transaction
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target confirm-otp-retry-by-transaction; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_OTP_12 | 400 | OTP_TRANSACTION_ALREADY_CONFIRMED | not published in this snapshot |
ERR_OTP_13 | 400 | OTP_HAS_EXPIRED_RETRY | There is already active OTP. endDate:{0} |
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND | not published in this snapshot |
ERR_OTP_4 | 400 | OTP_TRANSACTION_IS_NOT_FOUND | not published in this snapshot |
path Parameters
idtransactionIdaurax-bff-redirect-confirm-otp-retry-by-transaction › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-create-otp-transaction
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CreateOtpTransactionDto.
| Field | Declared type | Nullable |
|---|---|---|
OneTimePassword | string | no |
EndDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_OTP_15 | 400 | EMAIL_IS_INVALID |
ERR_OTP_2 | 400 | OTP_ITEM_IS_NOT_FOUND |
ERR_OTP_3 | 400 | OTP_ITEM_MUST_NOT_BE_PASSIVE |
ERR_OTP_6 | 400 | KEY_FORMAT_MUST_NOT_BE_NULL |
ERR_OTP_7 | 400 | KEY_FORMAT_MUST_NOT_BE_PASSIVE |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-create-otp-transaction › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.