Skip to main content

Otp v1.0

Manage Otp verification codes which allow customers to safe api access

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

Otp Verification Service

Otp Verification Controller

Request an otp

POST https://auvious.video:443/security/otp HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json

Request a otp verification code. Returns an otp verification id which should be passed on calls that are protected with otp.

Request body

{
"channel": "SMS",
"customName": "hello, world",
"locale": "en",
"to": "+306957206309"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyRequestOtpCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKOtpRequestResult
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"id": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/security/otp \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Schemas

OtpRequestResult

{
"id": "string"
}

OtpRequestResult

Properties

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone

RequestOtpCommand

{
"channel": "SMS",
"customName": "hello, world",
"locale": "en",
"to": "+306957206309"
}

RequestOtpCommand

Properties

NameTypeRequiredRestrictionsDescription
channelstringfalsenoneChannel to use
customNamestringfalsenonecustom name to use instead of default
localestringfalsenonelocale to use
tostringtruenoneWhere to?
Enumerated Values
PropertyValue
channelSMS
customNameany string
customNamebut keep it short
localeaf
localear
localeca
localecs
localeda
localede
localeel
localeen
localeen-GB
localees
localefi
localefr
localehe
localehi
localehr
localehu
localeid
localeit
localeja
localeko
localems
localenb
localenl
localeor zh-HK.
localepl
localepr-BR
localept
localero
localeru
localesv
localeth
localetl
localetr
localevi
localezh
localezh-CN
toany phone number
toor email if supported