Получение списка ключей доступа в тенанте
Метод и конечная точка
GET /tenants/{tenant_name}/domains/{domain}/promo_codes
Описание
Позволяет получить список ключей доступа, сгенерированных в указанном домене тенанта.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| creator | нет | string | Админ тенанта, при указании будут возвращены только созданные им ключи доступа |
| status | нет | string | Показать только ключи доступа с указанным статусом |
| tenant_name | да | string | Имя тенанта |
| domain | да | string | Домен, в котором сгенерированы ключи доступа |
Запрос
curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/domains/<DOMAIN>/promo_codes?\
creator=<CREATOR_NAME>&status=<STATUS>" \
-H 'accept: application/json'
где:
-
<TENANT_NAME>— имя тенанта; -
<DOMAIN>— домен, в котором выданы ключи доступа; -
<CREATOR_NAME>— ограничение вывода по указанному создателю ключей доступа; -
<STATUS>— ограничение вывода по статусу ключей доступа.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"promo_codes": [
"string",
]
}