Objektai

ApiKeyCreate

Laukai

• namestringprivalomas

  length ≥ 1, length ≤ 64

• rolestring

  Numatytoji reikšmė: "editor"

• data_profilestring | null

  Rakto duomenų profilis. Be šio lauko raktas gauna numatytąjį organizacijos profilį. Duomenų profilis netaikomas vaidmeniui admin. Raktas su administratoriaus vaidmeniu mato visus organizacijos duomenis, o kitas nei full profilis grąžina 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Rakto galiojimo pabaiga (ISO 8601, ateityje). null arba reikšmės nebuvimas reiškia, kad raktas galioja neribotai.

• scopesarray of ApiKeyScope | null

  Rakto apimtys. Jei jų nėra, apimtys nustatomos pagal vaidmenį: admin gauna read, write, admin; editor ir verifier – read, write; viewer – read. Apimtį system išduoda tik diegimo administratorius. Priimamos ir smulkios resource:action apimtys (ApiKeyScope); ankstesnės read, write ir admin išskleidžiamos į kelias apimtis.

• collection_idsarray of integer | null

  Apriboja raktą šiais organizacijos rinkiniais. Kortelės, paieška, atsakymai ir įvykiai veikia tik juose, be to, galioja vaidmens ir duomenų profilio apribojimai. Reikšmės nebuvimas arba tuščias sąrašas reiškia, kad apribojimo nėra. Jei kviečiantis raktas pats apribotas rinkiniais, naujasis raktas gali būti tik jo rinkiniuose. Be šio lauko naujasis raktas gauna kviečiančio rakto rinkinius. Tuščias sąrašas arba rinkinys už jo sąrašo ribų grąžina 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Tinklai, iš kurių galima naudoti raktą, pvz., 10.0.0.0/8 arba 2001:db8::/32. Vienas adresas – tai vieno adreso tinklas. Užklausa iš kito adreso grąžina 403 api_keys.ip_not_allowed. Reikšmės nebuvimas reiškia, kad apribojimo nėra.

  items ≤ 50

Naudoja

• POST/v1/api-keysSukurti API raktą