Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
IAM Reseller Users

Create a new user

Create a new user with client. The user and client will be activated automatically.

post/iam/users

Request body

emailstring email required

User's email address. This address will be used as client's email address by default.

passwordstring password required

User's password.

companystring required

Client's company name.

user_type'common'

User's type. It must be common.

namestring

User's name. This name will be used as client's name by default.

phonestring

User's phone number. This phone will be used as client's phone by default.

sellerinteger

Client's seller ID.

lang'de' | 'en' | 'ru' | 'zh' | 'az'

Language code.

custom_idstring

Client's custom ID. You can use this field for your internal identification.

country_codestring

Client's country code.

is_testboolean

System field:

  • true — a test account;
  • false — a production account.

Response

OK.

idinteger required

User's ID.

emailstring email required

User's email address.

namestring nullable required

User's name.

lang'de' | 'en' | 'ru' | 'zh' | 'az' required

User's language.

Defines language of the control panel and email messages.

phonestring nullable required

User's phone.

companystring required

User's company.

resellerinteger required

Services provider ID.

clientnumber required

User's account ID.

deletedboolean required

Deletion flag. If true then user was deleted.

activatedboolean required

Email confirmation:

  • true – user confirmed the email;
  • false – user did not confirm the email.
sso_authboolean required

SSO authentication flag. If true then user can login via SAML SSO.

two_faboolean required

Two-step verification:

  • true – user enabled two-step verification;
  • false – user disabled two-step verification.
auth_typesAuthType[] required

System field. List of auth types available for the account.

user_type'common' | 'reseller' | 'seller' required

User's type.

is_activeboolean required

User activity flag.

Example response

{
  "groups": [
    {
      "id": 1,
      "name": "Administrators"
    }
  ],
  "client_and_roles": [
    {
      "user_roles": [
        "2"
      ]
    }
  ]
}