Приглашение пользователя

Метод используется для приглашения пользователя присоединиться к указанному аккаунту. Можно пригласить как нового пользователя, так и уже зарегистрированного в платформе. В результате платформа создает приглашенного пользователя и отправляет на указанный email приглашение с токеном, который нужно использовать для вызова метода Валидация токена-приглашения.

Метод возвращает информацию о созданном пользователе без проверки факта отправки приглашения. Код ответа 201 Created. У текущего пользователя должен быть доступ к указанному аккаунту.

POST {reseller_domain}/internal_api/accounts/{account_id}/invited_users

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, от имени которого отправляется приглашение
email	form	string	Обязательный	Email, на который будет отправлено приглашение и который будет использоваться как логин для входа в Панель управления Клиента. Можно указать только email, которого нет в списке приглашенных пользователей (см. Получение списка приглашенных пользователей ) и среди существующих пользователей аккаунта вне зависимости от их статуса, т.е. можно пригласить как нового пользователя, так и уже зарегистрированного в платформе.
role	form	string	Обязательный	Уровень доступа в рамках указанного аккаунта, который будет назначен приглашенному пользователю (подробнее см. ): admin — Администратор. technical_manager — Технический менеджер. finance — Финансовый менеджер. user — Пользователь.

Модель ответа

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID приглашенного пользователя
	type		string	Тип данных
	attributes		object	Информация о приглашенном пользователе
		account_id	integer	ID аккаунта, от имени которого отправлено приглашение
		status	string	Статус приглашенного пользователя: active — Активный. Приглашение пользователя не использовано и не отозвано. inactive — Неактивный. Приглашение пользователя было использовано или отозвано. Приглашенный пользователь создается с `status = active`
		token	string	Токен-приглашение присоединиться к указанному аккаунту
		role	string	Уровень доступа в рамках указанного аккаунта, который будет назначен приглашенному пользователю (подробнее см. ): admin — Администратор. finance — Финансовый менеджер. user — Пользователь.
		email	string	Email, на который отправлено приглашение и который будет использоваться как логин для входа в Панель управления Клиента
		invite_date	string	Дата и время создания приглашения
		action	string	Параметр страницы входа при принятии приглашения: sign_up — регистрация. У реселлера нет пользователя клиента с указанным email. Чтобы присоединиться к аккаунту, пользователю нужно будет пройти быструю регистрацию. sign_in — вход. У реселлера есть пользователь клиента с указанным email.
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/1185/invited_users' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
    "data": {
        "attributes": {
            "email": "user1@example.com",
            "role": "admin"
        }
    }
}'

Пример ответа

JSON

{
    "data": {
        "id": "296",
        "type": "invited_users",
        "attributes": {
            "account_id": 1185,
            "status": "active",
            "token": "InviteTokenExample1",
            "role": "admin",
            "email": "user1@example.com",
            "invite_date": "2023-01-16T11:21:03.216155+0300",
            "action": "sign_up"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}