Ключи

Получить список всех ключей

Возвращает список всех ключей в организации.

Метод	Путь
GET	/v1/organizations/{organizationId}/keys

Запрос

Параметры пути

Имя	Тип	Описание
organizationId	uuid	ID запрашиваемой организации.

Ответ

Схема ответа

Имя	Тип	Описание
id	uuid	Уникальный ID API ключа.
name	string	Имя ключа
state	string	Состояние ключа: 'enabled', 'disabled'.
roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
keySuffix	string	Последние 4 символа ключа.
createdAt	date-time	Временная метка создания ключа. ISO-8601.
expireAt	date-time	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
usedAt	date-time	Временная метка последнего использования ключа. Если отсутствует, ключ никогда не использовался. ISO-8601.
ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

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

Создать ключ

Создает новый API ключ.

Метод	Путь
POST	/v1/organizations/{organizationId}/keys

Запрос

Параметры пути

Имя	Тип	Описание
organizationId	uuid	ID организации, которая будет владеть ключом.

Параметры тела

Имя	Тип	Описание
name	string	Имя ключа.
expireAt	string	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
state	string	Начальное состояние ключа: 'enabled', 'disabled'. Если не указано, новый ключ будет 'enabled'.
hashData
roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

Ответ

Схема ответа

Имя	Тип	Описание
key.id	uuid	Уникальный ID API ключа.
key.name	string	Имя ключа
key.state	string	Состояние ключа: 'enabled', 'disabled'.
key.roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
key.keySuffix	string	Последние 4 символа ключа.
key.createdAt	date-time	Временная метка создания ключа. ISO-8601.
key.expireAt	date-time	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
key.usedAt	date-time	Временная метка последнего использования ключа. Если отсутствует, ключ никогда не использовался. ISO-8601.
key.ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа
keyId	string	Сгенерированный ID ключа. Указывается только если в запросе не было 'hashData'.
keySecret	string	Секрет ключа, сгенерированный системой. Указывается только если в запросе не было 'hashData'.

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

Получить детали ключа

Возвращает детали одного ключа.

Метод	Путь
GET	/v1/organizations/{organizationId}/keys/{keyId}

Запрос

Параметры пути

Имя	Тип	Описание
organizationId	uuid	ID запрашиваемой организации.
keyId	uuid	ID запрашиваемого ключа.

Ответ

Схема ответа

Имя	Тип	Описание
id	uuid	Уникальный ID API ключа.
name	string	Имя ключа
state	string	Состояние ключа: 'enabled', 'disabled'.
roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
keySuffix	string	Последние 4 символа ключа.
createdAt	date-time	Временная метка создания ключа. ISO-8601.
expireAt	date-time	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
usedAt	date-time	Временная метка последнего использования ключа. Если отсутствует, ключ никогда не использовался. ISO-8601.
ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

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

Обновить ключ

Обновляет свойства API ключа.

Метод	Путь
PATCH	/v1/organizations/{organizationId}/keys/{keyId}

Запрос

Параметры пути

Имя	Тип	Описание
organizationId	uuid	ID организации, которая владеет ключом.
keyId	uuid	ID ключа для обновления.

Параметры тела

Имя	Тип	Описание
name	string	Имя ключа
roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
expireAt	string	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
state	string	Состояние ключа: 'enabled', 'disabled'.
ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

Ответ

Схема ответа

Имя	Тип	Описание
id	uuid	Уникальный ID API ключа.
name	string	Имя ключа
state	string	Состояние ключа: 'enabled', 'disabled'.
roles	array	Список ролей, назначенных ключу. Содержит как минимум 1 элемент.
keySuffix	string	Последние 4 символа ключа.
createdAt	date-time	Временная метка создания ключа. ISO-8601.
expireAt	date-time	Временная метка, когда ключ истекает. Если отсутствует или пуст, ключ никогда не истекает. ISO-8601.
usedAt	date-time	Временная метка последнего использования ключа. Если отсутствует, ключ никогда не использовался. ISO-8601.
ipAccessList	array	Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

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

Удалить ключ

Удаляет API ключ. Можно удалить только ключ, который не использовался для аутентификации текущего запроса.

Метод	Путь
DELETE	/v1/organizations/{organizationId}/keys/{keyId}

Запрос

Параметры пути

Имя	Тип	Описание
organizationId	uuid	ID организации, которая владеет ключом.
keyId	uuid	ID ключа для удаления.