Me

GET /me nennt, wem ein Token gehört und was es darf. Machen Sie ihn zur ersten Anfrage jeder Integration und jedes Agenten: Er bestätigt, dass das Token funktioniert, zeigt, zu welchem Mandanten es gehört, und ob es schreiben darf.

Das Modell der Identität

• Name

  identifier

  Typ

  string

  Beschreibung

  Die Kennung der Identität: die E-Mail-Adresse einer Person oder service-account: gefolgt von der UUID eines Service-Accounts.

• Name

  type

  Typ

  string

  Beschreibung

  user für ein persönliches API-Token, service-account für das Token eines Service-Accounts.

• Name

  uuid

  Typ

  string

  Beschreibung

  Die UUID des Kontos der Person oder des Service-Accounts.

• Name

  name

  Typ

  string

  Beschreibung

  Der vollständige Name der Person oder der Name des Service-Accounts.

• Name

  email

  Typ

  string

  Beschreibung

  Die E-Mail-Adresse der Person. Fehlt bei Service-Accounts.

• Name

  roles

  Typ

  string[]

  Beschreibung

  Die Rollen, die festlegen, welche Endpunkte das Token verwenden kann. Siehe Berechtigungen.

• Name

  scopes

  Typ

  string[]

  Beschreibung

  Die Scopes des verwendeten Tokens: api:read und, bei einem Token mit Schreibzugriff, api:write.

• Name

  access

  Typ

  string

  Beschreibung

  read oder write: was das Token darf, nachdem die Zugriffsstufe des Service-Accounts angewendet wurde.

• Name

  tenant

  Typ

  object

  Beschreibung

  Der Mandant, zu dem das Token gehört, mit slug und name. Nur bei Installationen mit mehreren Mandanten.

Die Identität abrufen

curl https://example.fepli.eu/api/me \
  -H "Authorization: Bearer $FEPLI_TOKEN"

{
  "identifier": "service-account:0193b2d6-5c1e-7a48-9e0f-4d2a6b8c1e10",
  "type": "service-account",
  "uuid": "0193b2d6-5c1e-7a48-9e0f-4d2a6b8c1e10",
  "name": "Auswertung",
  "roles": ["ROLE_ADMIN", "ROLE_USER", "ROLE_SERVICE_ACCOUNT"],
  "scopes": ["api:read"],
  "access": "read",
  "tenant": { "slug": "elmsbrueck", "name": "Ferienpass Elmsbrück" }
}