Objekter

ApiKeyCreate

Felter

• namestringpåkrævet

  length ≥ 1, length ≤ 64

• rolestring

  Standard: "editor"

• data_profilestring | null

  Nøglens dataprofil. Uden dette felt får nøglen organisationens standardprofil. En dataprofil gælder ikke for rollen admin. En nøgle med denne rolle ser alle organisationens data, og en anden profil end full returnerer 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Nøglens udløbstidspunkt (ISO 8601, i fremtiden). null eller ingen værdi betyder, at nøglen ikke udløber.

• scopesarray of ApiKeyScope | null

  Nøglens scopes. Mangler feltet, følger scopes rollen: admin får read, write, admin; editor og verifier får read, write; viewer får read. Scopet system udstedes kun af installationens administrator. Finkornede scopes af typen resource:action (ApiKeyScope) accepteres også; de tidligere read, write og admin udvides til sæt af scopes.

• collection_idsarray of integer | null

  Begrænser nøglen til disse samlinger i organisationen. Kort, søgning, svar og hændelser virker kun i dem, oven i rollen og dataprofilen. Ingen værdi eller en tom liste betyder ingen begrænsning. Er den kaldende nøgle selv begrænset til samlinger, kan den nye nøgle kun være i dens samlinger. Uden dette felt får den nye nøgle den kaldende nøgles samlinger. En tom liste eller en samling uden for dens liste returnerer 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Netværk, nøglen må bruges fra, fx 10.0.0.0/8 eller 2001:db8::/32. En enkelt adresse er et netværk med én adresse. En anmodning fra en anden adresse returnerer 403 api_keys.ip_not_allowed. Ingen værdi betyder ingen begrænsning.

  items ≤ 50

Bruges af

• POST/v1/api-keysOpret en API-nøgle