Перейти до вмісту
Sursa Developers

Об’єкти

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 — ключ діє безстроково.

Використовується в