Перейти к содержанию
Sursa для разработчиков

Объекты

ApiKeyUpdate

Изменения ключа. Непереданные поля не меняются, а data_profile необязателен. Пустой список scopes означает области по роли, пустые collection_ids и allowed_cidrs — отсутствие ограничений, а expires_at, равный null, — бессрочный ключ. Ключ, который сам ограничен коллекциями, не может снять или расширить ограничение по коллекциям (collection_ids).

Поля

  • data_profilestring

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

  • scopesarray of ApiKeyScope

    Области доступа ключа. Область system через API не выдаётся.

  • collection_idsarray of integer

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

    items ≤ 100

  • allowed_cidrsarray of string

    Сети, из которых можно использовать ключ.

    items ≤ 50

  • expires_atstring (date-time) | null

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

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