Invitations

Создать общую ссылку на роль

Одна ссылка на роль для многих — подрядчики, склад, волна найма. Каждый, кто войдёт или зарегистрируется по ней, становится участником с этой ролью; карточка «Команды» заводится новой с почтой его учётной записи, а если карточка с этой почтой уже есть — принятие отказывает invitations.shared_link.email_taken (нужно личное приглашение). Лимит принятий max_uses от 1 до 500 (по умолчанию 10), срок expires_in_days от 1 до 90 дней (по умолчанию 7), иначе 400 invitations.shared_link.limit_invalid. Роль — не шире прав создающего. Внешним и гостям нужна организация. Ссылка возвращается в invite_url только в этом ответе.

post/api/v1/invitations/shared-links

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/invitations/shared-links
  • 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

role_idstring uuid required
max_usesinteger

Сколько человек может присоединиться по ссылке

expires_in_daysinteger

Срок действия ссылки в днях

access_untilstring date nullable

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

affiliation'own' | 'external' | 'guest'

Кем приходят: own — свои, external — внешние участники, guest — гости-подрядчики (места тарифа не занимают)

organization_contact_idstring uuid nullable

Контрагент-организация внешних и гостей; обязателен при affiliation external и guest

Response

Общая ссылка и её адрес

idstring uuid required
tenant_idstring uuid required
tenant_namestring
role_idstring uuid required
role_namestring
affiliation'own' | 'external' | 'guest' required
organization_contact_idstring uuid
access_untilstring date
max_usesinteger required
used_countinteger required
expires_atstring date-time required
created_byinteger required
created_by_namestring
created_atstring date-time required
revoked_atstring date-time
status'active' | 'expired' | 'exhausted' | 'revoked' required
invite_urlstring

Адрес ссылки; только в ответе на создание

Changes

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