Создание задачи для получения списка пользователей тенанта Microsoft

Метод используется для создания асинхронной задачи для получения одностраничного списка пользователей тенанта Microsoft для аккаунта, к которому есть доступ у текущего пользователя. Для получения списка пользователей тенанта Microsoft у аккаунта в платформе должны быть сохранены Tenant Name и Tenant ID. Модуль MicrosoftCSPProductsPlugin запрашивает информацию о тенанте аккаунта на стороне Microsoft (см. Получение списка всех учетных записей пользователей для клиента).

POST {reseller_domain}/plugin_microsoft_csp_products/internal_api/tenant_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	query	integer	Обязательный	ID аккаунта, для которого запрашивается список пользователей его тенанта Microsoft

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

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID асинхронной задачи
	type		string	Тип данных
	attributes		object	Информация об асинхронной задаче
		status	string	Статус асинхронной задачи: pending — асинхронная задача создана. running — асинхронная задача выполняется.
		failure_message	string	Текст ошибки на стороне платформы (пустое значение)
		result	object	Результат выполнения асинхронной задачи (null)
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request POST 'https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/tenant_users?account_id=1938' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": {
        "id": "829e4cf3-459f-4db4-8af8-6ee9bbf34e35",
        "type": "async_tasks",
        "attributes": {
            "status": "pending",
            "failure_message": "",
            "result": null
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}