Open confirmation email URL

POST /api/2.0/authentication/confirm

Request

Opens a confirmation email URL to validate a certain action (employee invitation, portal removal, phone activation, etc.).

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Confirmation email parameters

keystring

Key

emplTypeone of

.enum of string

[All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]

Can be one of: All, RoomAdmin, Guest, DocSpaceAdmin, User.

.enum of integer

[0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]

Can be one of: 0, 1, 2, 3, 4.

emailstringformat: email

Email

uiDstringformat: uuid

User ID

typeone of

.enum of string

[EmpInvite - Emp invite, LinkInvite - Link invite, PortalSuspend - Portal suspend, PortalContinue - Portal continue, PortalRemove - Portal remove, DnsChange - Dns change, PortalOwnerChange - Portal owner change, Activation - Activation, EmailChange - Email change, EmailActivation - Email activation, PasswordChange - Password change, ProfileRemove - Profile remove, PhoneActivation - Phone activation, PhoneAuth - Phone auth, Auth - Auth, TfaActivation - Tfa activation, TfaAuth - Tfa auth, Wizard - Wizard]

Can be one of: EmpInvite, LinkInvite, PortalSuspend, PortalContinue, PortalRemove, DnsChange, PortalOwnerChange, Activation, EmailChange, EmailActivation, PasswordChange, ProfileRemove, PhoneActivation, PhoneAuth, Auth, TfaActivation, TfaAuth, Wizard.

.enum of integer

[0 - Emp invite, 1 - Link invite, 2 - Portal suspend, 3 - Portal continue, 4 - Portal remove, 5 - Dns change, 6 - Portal owner change, 7 - Activation, 8 - Email change, 9 - Email activation, 10 - Password change, 11 - Profile remove, 12 - Phone activation, 13 - Phone auth, 14 - Auth, 15 - Tfa activation, 16 - Tfa auth, 17 - Wizard]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17.

firststring

Access an account for the first time or not

roomIdstring

Room ID

Examples

POST /api/2.0/authentication/confirm HTTP/1.1
Accept: application/json
Content-Length: 153
Content-Type: application/json
Host: example.com

{
  "key": "some text",
  "email": "Verla_Kiehn2@gmail.com",
  "uiD": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "first": "some text",
  "roomId": "956"
}

curl --request POST \
  --url https://example.com/api/2.0/authentication/confirm \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "some text",
  "email": "Verla_Kiehn2@gmail.com",
  "uiD": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "first": "some text",
  "roomId": "956"
}'

Responses

200

Validation result: Ok, Invalid, or Expired

resultone of

.enum of string

[Ok - Ok, Invalid - Invalid, Expired - Expired, TariffLimit - Tariff limit, UserExisted - User existed, UserExcluded - User excluded, QuotaFailed - Quota failed]

Can be one of: Ok, Invalid, Expired, TariffLimit, UserExisted, UserExcluded, QuotaFailed.

.enum of integer

[0 - Ok, 1 - Invalid, 2 - Expired, 3 - Tariff limit, 4 - User existed, 5 - User excluded, 6 - Quota failed]

Can be one of: 0, 1, 2, 3, 4, 5, 6.

roomIdstring

Room id

titlestring

Title