Breadcrumbs

Получение Customer Consent

Получение Customer Consent доступно только при наличии подходящих Admin Relationships (см. Microsoft GDAP).

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

В результате вызова метода создается асинхронная задача в статусе pending. Код ответа 201 Created. Если задача в статусе pending или running уже существует, то метод возвращает ID существующий задачи, а новая задача не создается. См. также Проверка результатов получения Customer Consent).

POST {reseller_domain}/plugin_microsoft_csp_products/internal_api/customer_consent_check

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого выполняется получение Customer Consent

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

Название

Тип данных

Описание

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/customer_consent_check?account_id=349' \
--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"
    }
}