Administrator v1 /api/v1/general/admin_users/sign_in

Schnittstelle für das Anmelden als Administrator

Diese Schnittstelle stellt die Informationen eines Benutzers (Administrator) bei Übergabe der korrekten Credentials zur Verfügung.

Überblick

Klasse / Datentyp
Administrator
Response Formats
JSON
API Version
v1
Öffentlich erreichbar
false
HTTP Methode
POST
Zuletzt aktualisiert

/api/v1/general/admin_users/sign_in

Parameter

Body Parameter

Schlüssel
acl_admin_user[email] Pflicht

E-Mail Adresse des Acl::AdminUser

acl_admin_user[password] Pflicht

Password des Acl::AdminUser

Beispiel Rückgabe

{
  "id"                   : "XXXXXXX",
  "email"                : "lehmann@squibble.me",
  "firstname"            : "Patrick",
  "lastname"             : "Lehmann",
  "authentication_token" : "XXXXXXX",
  "default_principal"    : {
    "id"          : "XXXXXXX",
    "name"        : "Squibble",
    "site_name"   : "Squibble",
    "main_domain" : "squibble.me"
  },
  "default_employee"     : {
    "id"        : "XXXXXXX",
    "email"     : "lehmann@squibble.me",
    "firstname" : "Patrick",
    "lastname"  : "Lehmann"
  },
  "roles"                : [
    {
      "id"    : "CCCCCCCCCCC",
      "key"   : "super_administrator",
      "label" : "Super Administrator"
    },
    {"id" : "CCCCCCCCCCC","key" : "administrator","label" : "Administrator"}
  ],
  "created_at"           : "2014-02-02 21:21:11 +0100",
  "updated_at"           : "2016-08-14 22:21:58 +0200"
}