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

Метод используется для получения списка пользователей тенанта Microsoft в виде информации об асинхронной задаче (см. Создание задачи для получения списка пользователей тенанта Microsoft и Получение списка всех учетных записей пользователей для клиента).

GET {reseller_domain}/plugin_microsoft_csp_products/internal_api/async_tasks/{async_task_id}

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

Авторизация

Требуется авторизация с помощью 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	Обязательный	Доменное имя реселлера
async_task_id	path	string	Обязательный	ID асинхронной задачи

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

Название				Тип данных	Описание	Параметр ответа от Microsoft
data				object	Данные ответа	-
	id			string	ID асинхронной задачи	-
	type			string	Тип данных	-
	attributes			object	Информация об асинхронной задаче	-
		status		string	Статус асинхронной задачи: pending — создана. running — выполняется. completed — завершена успешно. failed — завершена неуспешно из-за ошибки на стороне платформы.	-
		failure_message		string	Текст ошибки на стороне платформы	-
		result		array of objects	Список пользователей тенанта Microsoft	-
			id	string	ID пользователя	items.id
			user_principal_name	string	Email пользователя	items.userPrincipalName
			usage_location	string	Локация пользователя, место, где пользователь намеревается использовать лицензию	items.usageLocation
			first_name	string	Имя пользователя	items.firstName
			last_name	string	Фамилия пользователя	items.lastName
			display_name	string	Полное имя пользователя	items.displayName
			user_domain_type	string	Тип домена пользователя	items.userDomainType
			state	string	Статус пользователя	items.state
meta				object	Дополнительная информация	-
	server_current_time			string	Текущие дата и время сервера	-

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

Bash

curl --location 'https://test.activeplatform.com/internal_api/async_tasks/829e4cf3-459f-4db4-8af8-6ee9bbf34e35' \
--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": "completed",
            "failure_message": "",
            "result": [
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "user_principal_name": "admin@example.onmicrosoft.com",
                    "usage_location": "US",
                    "first_name": "Adam",
                    "last_name": "Smith",
                    "display_name": "Adam Smith",
                    "user_domain_type": "none",
                    "state": "active"
                },
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "user_principal_name": "user@example.onmicrosoft.com",
                    "usage_location": "US",
                    "first_name": "Gerra",
                    "last_name": "Mirin",
                    "display_name": "Gerra Mirin",
                    "user_domain_type": "none",
                    "state": "active"
                }
            ]
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}

Пример ответа с ошибкой no_admin_relationships

Ошибка no_admin_relationships возникает, если со стороны Microsoft возвращается ошибка 403 Forbidden с кодом 9000. В этом случае нужно проверить статус Admin Relationships (GDAP) и получить ссылку для клиента, чтобы он принял приглашение от реселлера. Подробнее см. Microsoft GDAP.

JSON

{
    "data": {
        "id": "c63ad52f-b43f-4e02-b702-b8656924abe4",
        "type": "async_tasks",
        "attributes": {
            "status": "failed",
            "failure_message": "no_admin_relationships",
            "result": null
        }
    },
    "meta": {
        "server_current_time": "2024-09-12T07:50:10.906822+0000"
    }
}