Objektid

ApiKeyCreate

Väljad

• namestringkohustuslik

  length ≥ 1, length ≤ 64

• rolestring

  Vaikimisi: "editor"

• data_profilestring | null

  Võtme andmeprofiil. Ilma selle väljata saab võti organisatsiooni vaikeprofiili. Andmeprofiil rollile admin ei rakendu. Administraatori rolliga võti näeb kõiki organisatsiooni andmeid ja muu profiil kui full tagastab vastuse 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Võtme aegumise aeg (ISO 8601, tulevikus). null või puuduv väärtus tähendab, et võti ei aegu.

• scopesarray of ApiKeyScope | null

  Võtme ulatused. Kui need puuduvad, järgivad ulatused rolli: admin saab ulatused read, write, admin; editor ja verifier saavad read, write; viewer saab read. Ulatuse system väljastab ainult paigalduse administraator. Aktsepteeritakse ka täpseid ulatusi kujul resource:action (ApiKeyScope); varasemad read, write ja admin laienevad ulatuste komplektideks.

• collection_idsarray of integer | null

  Piirab võtme nende organisatsiooni kogudega. Kaardid, otsing, vastused ja sündmused töötavad ainult neis, lisaks rollile ja andmeprofiilile. Puuduv väärtus või tühi loend tähendab, et piirangut pole. Kui päringu teinud võti on ise kogudega piiratud, saab uus võti olla ainult selle kogudes. Ilma selle väljata saab uus võti päringu teinud võtme kogud. Tühi loend või selle loendist väljaspool olev kogu tagastab 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Võrgud, millest võtit tohib kasutada, näiteks 10.0.0.0/8 või 2001:db8::/32. Üksik aadress on ühe aadressiga võrk. Päring muult aadressilt tagastab vastuse 403 api_keys.ip_not_allowed. Puuduv väärtus tähendab, et piirangut pole.

  items ≤ 50

Kasutatakse

• POST/v1/api-keysAPI-võtme loomine