Invitations

Пригласить человека по почте

Выпускает одноразовую ссылку в кабинет с ролью и по умолчанию отправляет её письмом. Ожидающее приглашение на ту же почту обновляется, а не дублируется. С employee_id почта сверяется с карточкой «Команды», и после принятия карточка получает учётную запись. С send_email false письма нет, а ссылка возвращается в invite_url — передайте её человеку сами. Принять ссылку можно, только войдя с этой почтой. Если почтовый сервер не принял письмо — 502 invitations.delivery_failed, ссылка не остаётся действующей.

post/api/v1/invitations

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/invitations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Request body

emailstring required

Рабочая почта

employee_idstring uuid
role_idstring uuid
company_scope'all' | 'selected'

Умолчание — all. selected отклоняется 400 invitations.company_scope_retired

company_idsUUID[]
send_emailboolean

false — без письма, ссылка в invite_url ответа

access_untilstring date nullable

Последний день доступа ГГГГ-ММ-ДД (внешнему участнику — на срок внедрения); пусто — бессрочно. Прошедшая дата — 400 invitations.access_until_invalid

Response

Приглашение

idstring uuid required
tenant_idstring uuid required
tenant_namestring
emailstring required

Почта приглашения в нижнем регистре; принять можно только войдя с ней

employee_idstring uuid
employee_namestring

ФИО карточки «Команды»

first_namestring
last_namestring
middle_namestring
role_idstring uuid required
role_namestring
company_scopestring required

Всегда all — область задают бизнесы участника после принятия

company_idsUUID[] required
invited_byinteger required
invited_by_namestring
status'pending' | 'accepted' | 'revoked' | 'expired' required
expires_atstring date-time required
accepted_user_idinteger
created_atstring date-time required
accepted_atstring date-time
revoked_atstring date-time
invite_urlstring

Одноразовая ссылка; только в ответе без письма и у выпуска ссылки

access_untilstring date

Последний день доступа ГГГГ-ММ-ДД: после принятия становится датой закрытия доступа участника; нет поля — бессрочно

link_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.