Към съдържанието
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 означава, че ключът не изтича.

Използва се в