Объекты

ApiKeyCreate

Поля

• namestringобязательно

  length ≥ 1, length ≤ 64

• rolestring

  По умолчанию: "editor"

• data_profilestring | null

  Профиль доступа ключа. Без него ключ получает профиль организации по умолчанию. Профиль доступа не применяется к роли admin. Ключ администратора видит все данные организации, а профиль, отличный от full, возвращает 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Время истечения ключа (ISO 8601, в будущем). null или отсутствие значения — ключ бессрочный.

• scopesarray of ApiKeyScope | null

  Области доступа ключа. Если не заданы, они следуют за ролью: admin получает read, write, admin; editor и verifier — read, write; viewer — read. Область system выдаёт только администратор установки. Принимаются и тонкие области вида resource:action (ApiKeyScope); прежние read, write и admin раскрываются в наборы областей.

• collection_idsarray of integer | null

  Ограничивает ключ этими коллекциями организации. Карточки, поиск, ответы и события работают только в них — поверх роли и профиля доступа. Нет значения или пустой список — без ограничения. Если вызывающий ключ сам ограничен коллекциями, новый ключ может быть только в его коллекциях. Без этого поля новый ключ получает коллекции вызывающего ключа. Пустой список или коллекция вне его списка возвращают 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Сети, из которых можно использовать ключ, например 10.0.0.0/8 или 2001:db8::/32. Отдельный адрес — это сеть из одного адреса. Запрос с другого адреса возвращает 403 api_keys.ip_not_allowed. Нет значения — без ограничения.

  items ≤ 50

Используется в

• POST/v1/api-keysСоздать ключ API