Skip to main content
GET
API-Tokens auflisten

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Query Parameters

page
integer
default:1

The collection page number

Response

200 - application/json

ApiToken collection

id
string
read-only
Example:

"A1B2C3D4E5F6G7H8I9J0"

tokenPrefix
string
read-only

First characters of the secret, to recognise the token. The full secret is only shown once on creation.

Example:

"api_1a2b3c4d"

scope
enum<string>

Scope of the token: read (GET/HEAD/OPTIONS only) or write.

Available options:
read,
write
Example:

"read"

description
string | null

Description of the API token

Example:

"My API token"

expiresAt
string<date-time> | null

Date and time when the API token expires. If null, the token never expires.

Example:

"2021-01-01T00:00:00+00:00"

revokedAt
string<date-time> | null
read-only

Date and time when the API token was revoked. If null, the token is active.

lastUsedAt
string<date-time> | null
read-only

Date and time when the API token was last used.

lastUsedIp
string | null
read-only

Client IP address of the last recorded use.

Example:

"203.0.113.7"

mfaProvenAt
string<date-time> | null

Date and time of the second factor that was proven when this token was issued. If null, no factor was proven.

createdAt
string<date-time>
updatedAt
string<date-time>
customerId
string | null
read-only

Customer the token is bound to. Null if the membership was removed (the token no longer works).

Example:

"01HXYZ..."

customerName
string | null
read-only

Name of the customer the token is bound to.

Example:

"Acme GmbH"