Objekte

ApiKeyCreate

Felder

• namestringerforderlich

  length ≥ 1, length ≤ 64

• rolestring

  Standard: "editor"

• data_profilestring | null

  Datenprofil des Schlüssels. Ohne dieses Feld erhält der Schlüssel das Standardprofil der Organisation. Ein Datenprofil gilt nicht für die Rolle admin. Ein Schlüssel mit dieser Rolle sieht alle Daten der Organisation, und ein anderes Profil als full ergibt 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Ablaufzeitpunkt des Schlüssels (ISO 8601, in der Zukunft). null oder kein Wert bedeutet, dass der Schlüssel nicht abläuft.

• scopesarray of ApiKeyScope | null

  Scopes des Schlüssels. Fehlen sie, richten sich die Scopes nach der Rolle: admin erhält read, write, admin; editor und verifier erhalten read, write; viewer erhält read. Der Scope system wird nur vom Administrator der Installation vergeben. Feingranulare Scopes resource:action (ApiKeyScope) werden ebenfalls akzeptiert; die früheren read, write und admin werden zu Sätzen von Scopes erweitert.

• collection_idsarray of integer | null

  Beschränkt den Schlüssel auf diese Sammlungen der Organisation. Karten, Suche, Antworten und Ereignisse funktionieren nur in ihnen, zusätzlich zu Rolle und Datenprofil. Kein Wert oder eine leere Liste bedeutet keine Beschränkung. Ist der aufrufende Schlüssel selbst auf Sammlungen beschränkt, kann der neue Schlüssel nur in dessen Sammlungen liegen. Ohne dieses Feld erhält der neue Schlüssel die Sammlungen des aufrufenden Schlüssels. Eine leere Liste oder eine Sammlung außerhalb seiner Liste ergibt 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Netzwerke, aus denen der Schlüssel verwendet werden darf, etwa 10.0.0.0/8 oder 2001:db8::/32. Eine einzelne Adresse ist ein Netzwerk aus einer Adresse. Eine Anfrage von einer anderen Adresse ergibt 403 api_keys.ip_not_allowed. Kein Wert bedeutet keine Beschränkung.

  items ≤ 50

Verwendet von

• POST/v1/api-keysAPI-Schlüssel erstellen