Към съдържанието
Sursa Developers

Обекти

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

Използва се в