Регистрация профилей

Отправить приглашения на регистрацию

POST /(company_code)/v2/auth/invite

Пригласить к регистрации профиля

Позволяет авторизованным пользователям приглашать новых пользователей к регистрации на создание профиля. На предоставленные адреса электронной почты будут высланы ссылки на регистрацию.

Ссылки на регистрацию, отправленные авторизованным пользователем с ролью PARTNER, позволяют регистрировать профили с ролью USER. Ссылки на регистрацию, отправленные авторизованным пользователем с ролью COMPANY, позволяют регистрировать профили с ролью EMPLOYEE.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект запроса:
 
  • primary_emails (array) – Основной адрес email для нового профиля
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed

Подробнее см. Коды ошибок.

Зарегистрировать профиль

POST /(company_code)/v2/auth/signup

Зарегистрировать профиль по ссылке приглашения

Этот вызов проверяет токен из ссылки приглашения, отправленной на электронную почту, и создает новый профиль для пользователя.

Ссылки на регистрацию, отправленные авторизованным пользователем с ролью PARTNER, позволяют регистрировать профили с ролью USER. Ссылки на регистрацию, отправленные авторизованным пользователем с ролью COMPANY, позволяют регистрировать профили с ролью EMPLOYEE.

Если адрес почты из ссылки приглашения уже использован как основной идентификатор профиля, возвращает код ошибки profile.identifier.used.

Если качество переданного нового пароля слишком низкое, возвращает код ошибки request.validation.failed со статусом HTTP 422.

JSON-объект запроса:
 
  • token (string) – Токен из ссылки приглашения, отправленной на email
  • captcha_response (string) – Ответный токен captcha пользователя в виде, предоставленном Recaptcha
  • new_password (string) – Новый пароль пользователя
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.expired
  • auth.token.invalid
  • auth.captcha.invalid
  • auth.restricted
  • profile.identifier.used
  • request.validation.failed

Подробнее см. Коды ошибок.