Objecten

ApiKeyCreate

Velden

• namestringverplicht

  length ≥ 1, length ≤ 64

• rolestring

  Standaard: "editor"

• data_profilestring | null

  Dataprofiel van de sleutel. Zonder dit veld krijgt de sleutel het standaardprofiel van de organisatie. Een dataprofiel geldt niet voor de rol admin. Een sleutel met die rol ziet alle gegevens van de organisatie, en een ander profiel dan full geeft 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Verlooptijdstip van de sleutel (ISO 8601, in de toekomst). null of geen waarde betekent dat de sleutel niet verloopt.

• scopesarray of ApiKeyScope | null

  Scopes van de sleutel. Ontbreekt het veld, dan volgen de scopes de rol: admin krijgt read, write, admin; editor en verifier krijgen read, write; viewer krijgt read. De scope system wordt alleen door de beheerder van de installatie uitgegeven. Fijnmazige scopes resource:action (ApiKeyScope) worden ook geaccepteerd; de eerdere read, write en admin worden uitgebreid tot sets van scopes.

• collection_idsarray of integer | null

  Beperkt de sleutel tot deze collecties van de organisatie. Kaarten, zoeken, antwoorden en events werken alleen daarin, bovenop de rol en het dataprofiel. Geen waarde of een lege lijst betekent geen beperking. Is de aanroepende sleutel zelf beperkt tot collecties, dan kan de nieuwe sleutel alleen in de collecties van die sleutel liggen. Zonder dit veld krijgt de nieuwe sleutel de collecties van de aanroepende sleutel. Een lege lijst of een collectie buiten de lijst van die sleutel geeft 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Netwerken van waaruit de sleutel mag worden gebruikt, zoals 10.0.0.0/8 of 2001:db8::/32. Eén adres is een netwerk van één adres. Een request vanaf een ander adres geeft 403 api_keys.ip_not_allowed. Geen waarde betekent geen beperking.

  items ≤ 50

Gebruikt door

• POST/v1/api-keysAPI-sleutel maken