Получение результатов проверки Admin Relationships (GDAP)

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

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 асинхронной задачи

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

Название				Тип данных	Описание
data				object	Данные ответа
	id			string	ID асинхронной задачи
	type			string	Тип данных
	attributes			object	Информация об асинхронной задаче
		status		string	Статус асинхронной задачи: pending — создана. running — выполняется, идет проверка. completed — завершена успешно. failed — завершена неуспешно из-за ошибки на стороне платформы.
		failure_message		string	Текст ошибки на стороне платформы
		result		object	Результат проверки Admin Relationships (GDAP) на стороне Microsoft
			error	string	Код и текст ошибки, полученной от Microsoft при проверке Admin Relationships
			confirmation_link	string	Ссылка для клиента, чтобы подтвердить Admin Relationships. Возвращается, если `admin_relationship_status = approval_pending`
			admin_relationship_name	string	Название Admin Relationships. Если Admin Relationships созданы платформой, значение по шаблону `GDAP - {{Timestamp}}`
			admin_relationship_status	string	Статус Admin Relationships: active — у клиента есть Admin Relationships в статусе Active и Security group, в которую входит приложение ActivePlatform. approval_pending — у клиента есть Admin Relationships в статусе Approve Pending, которые требуют подтверждения со стороны клиента. null — при выполнении одного из запросов была получена ошибка со стороны Microsoft.
meta				object	Дополнительная информация
	server_current_time			string	Текущие дата и время сервера

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

Bash

curl --location --request GET '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": {
                "error": null,
                "confirmation_link": null,
                "admin_relationship_name": "Default_LLC",
                "admin_relationship_status": "active"
            }
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}