Об’єкти

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