Einen API-Schlüssel erstellen¶

Note

Der geheime Schlüssel ist nur beim Erstellen eines API-Schlüssels sichtbar. Speichern Sie ihn an einem sicheren Ort, da er danach nicht erneut angezeigt werden kann.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Senden einer POST-Anfrage an den Endpunkt /user/{id}/api-keys.

Beschreibung¶

Mit der Create-API-Key-Anfrage erstellen Sie einen neuen API-Schlüssel für ein Benutzerkonto der Organisation.

Voraussetzungen¶

Werte der Anfrage: User-ID {id}

Objekte: ApiKeyVO

Anfrage¶

Um einen API-Schlüssel für ein Benutzerkonto der Organisation zu erstellen, fügen Sie die User-ID {id} dem Pfad der Anfrage hinzu.

Für eine detaillierte Spezifikation, welche Informationen zum Erstellen eines API-Schlüssels für ein Benutzerkonto erforderlich sind, müssen im Body ein oder mehrere Objekte ApiKeyVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`name`	Der individuelle Name des API-Schlüssels.	`string`

Als Ergebnis erhalten Sie ein oder mehrere Objekte ApiKeyVO mit den Informationen zum neuen API-Schlüssel.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`key`	Das Token des API-Schlüssels.	`string`
`secret`	Das Secret für die Authentifizierung über die REST-API.	`string`
`name`	Der individuelle Name des API-Schlüssels.	`string`
`deleted`	Zeigt an, ob der Schlüssel gelöscht wurde.	`true` `false`
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Request-Body:

{
  "name": "string",
  "key": "string",
  "secret": "string",
  "deleted": true
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.