Objekt

ApiKeyCreate

Fält

• namestringobligatorisk

  length ≥ 1, length ≤ 64

• rolestring

  Standard: "editor"

• data_profilestring | null

  Nyckelns dataprofil. Utan det här fältet får nyckeln organisationens standardprofil. En dataprofil gäller inte rollen admin. En nyckel med den rollen ser all data i organisationen, och en annan profil än full returnerar 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Nyckelns utgångstid (ISO 8601, i framtiden). null eller inget värde betyder att nyckeln inte upphör att gälla.

• scopesarray of ApiKeyScope | null

  Nyckelns omfång. Om fältet saknas följer omfången rollen: admin får read, write, admin; editor och verifier får read, write; viewer får read. Omfånget system utfärdas bara av installationens administratör. Detaljerade omfång resource:action (ApiKeyScope) accepteras också; de tidigare read, write och admin expanderas till uppsättningar av omfång.

• collection_idsarray of integer | null

  Begränsar nyckeln till dessa samlingar i organisationen. Kort, sökning, svar och händelser fungerar bara i dem, utöver rollen och dataprofilen. Inget värde eller en tom lista betyder ingen begränsning. Om den anropande nyckeln själv är begränsad till samlingar kan den nya nyckeln bara ligga i dess samlingar. Utan det här fältet får den nya nyckeln den anropande nyckelns samlingar. En tom lista eller en samling utanför dess lista returnerar 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Nätverk som nyckeln får användas från, till exempel 10.0.0.0/8 eller 2001:db8::/32. En enskild adress är ett nätverk med en adress. Ett anrop från en annan adress returnerar 403 api_keys.ip_not_allowed. Inget värde betyder ingen begränsning.

  items ≤ 50

Används av

• POST/v1/api-keysSkapa en API-nyckel