Register a new portal

POST /api/portal/register

Request

Registers a new portal with the parameters specified in the request.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

firstNamestringrequired

Portal owner first name

emailstringrequired

Portal owner email address

languagestring

Portal language

lastNamestringrequired

Portal owner last name

passwordstring

Portal owner password

phonestring

Portal owner phone number

portalNamestringrequired

Portal name

timeZoneNamestring

Portal time zone

Examples

POST /api/portal/register HTTP/1.1
Accept: application/json
Content-Length: 195
Content-Type: application/json
Host: example.com

{
  "firstName": "John",
  "email": "test@example.com",
  "language": "en",
  "lastName": "Smith",
  "password": 123456,
  "phone": 123456789,
  "portalName": "example",
  "timeZoneName": "UTC"
}

curl --request POST \
  --url https://example.com/api/portal/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "John",
  "email": "test@example.com",
  "language": "en",
  "lastName": "Smith",
  "password": 123456,
  "phone": 123456789,
  "portalName": "example",
  "timeZoneName": "UTC"
}'

Responses

200

The link for portal activation and portal description.

referencestring

tenantobject

createdstringformat: date-time

domainstring

languagestring

ownerIdstring

portalNamestring

statusstring

tenantIdinteger

timeZoneNamestring

400

Bad Request

errorenum of string

• params - An error has been made in the method parameters specified in the request.
• passPolicyError - The password specified in the request does not meet the requirements.
• portalNameEmpty - The required parameter portalName, which must be present in the request, is not specified.
• portalNameExist - Portal with the portal name specified in the request has already been registered.
• portalNameIncorrect - Invalid characters in the portalName parameter.
• portalNameNotFound - No portal with the portal name specified in the request has been registered.
• portalsCountTooMuch - The limit for the number of portals has been reached.
• recaptchaInvalid - Invalid reCAPTCHA value has been entered.
• tooMuchAttempts - The limit for the number of request attempts has been reached.
• tooShortError - The portalName specified in the request is too short.

Can be one of: params, passPolicyError, portalNameEmpty, portalNameExist, portalNameIncorrect, portalNameNotFound, portalsCountTooMuch, recaptchaInvalid, tooMuchAttempts, tooShortError.

403

Forbidden

errorenum of string

• authorization - Authorization error, the possible reasons: an unknown authorization scheme is used, or the authorization key is missing, or the authorization key time is out, or a wrong key is used.

Can be one of: authorization.

500

Internal Server Error

errorenum of string

• authorization - Internal server error when decoding the authorization key.
• registerNewTenantError - An error occurred while registering a new portal.
• error - An internal server error occurred.

Can be one of: authorization, registerNewTenantError, error.