Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

(Verbraucher-)Administrations-APIs

Beitragende

Die (Verbraucher-)Administrations-APIs bestehen aus Methoden, mit denen Sie die folgenden Aufgaben ausführen können:

Die folgende Tabelle enthält die in diesem Abschnitt dokumentierten Consumer-APIs.

HTTP-Methode Pfad Beschreibung

POST

/v2.1/auth/password

Legen Sie das Kennwort für einen Benutzer fest.

POST

/v2.1/auth/password

Authentifizierung JWT aktualisieren.

POST

/v2.1/auth/sign

Anmelden.

GET

/v2.1/auth/Regions

Bereiche abrufen.

GET

/v2.1/auth/Regions/{Name}

Bereiche nach Namen abrufen.

GET

/v2.1/auth/Zones

Zonen abrufen.

GET

/v2.1/auth/Zones/{Name}

Zonen nach Namen abrufen.

GET

/v2.1/Jobs/

Jobs abrufen.

GET

/v2.1/Jobs/{id}

Jobs nach ID abrufen.

Benutzerpasswort zurücksetzen

Verwenden Sie die in der folgenden Tabelle aufgeführte Methode, um das Benutzerpasswort zurückzusetzen.

HTTP-Methode Pfad Beschreibung Parameter

POST

/v2.1/auth/password

Setzen Sie das Passwort zurück.

Keine

Erforderliche Body-Attribute für Anforderung: Benutzername (Zeichenfolge), New_password (Zeichenfolge)

Beispiel des Körpers anfordern:

{
  "username": "MyName",
  "old_password": "oldPassword",
  "new_password": "newPassword"
}

Beispiel des Antwortkörpers:

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNjg3MX0.ZuRXjDPVtc2pH-e9wqgmszVKCBYS2PLqux2YwQ5uoAM"
      }
    ]
  }
}

Authentifizierungs-Token aktualisieren

Verwenden Sie die in der folgenden Tabelle aufgeführte Methode, um das Authentifizierungs-Token zu aktualisieren.

HTTP-Methode Pfad Beschreibung Parameter

POST

/v2.1/auth/Refresh

Aktualisieren Sie das Authentifizierungs-Token.

Keine

Erforderliche Body-Attribute für Anforderung: none

Beispiel des Körpers anfordern:

none

Beispiel des Antwortkörpers:

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5d914547869caefed0f3a00c",
          "username": "myusername",
          "firstName": "myfirstname",
          "lastName": "",
          "displayName": "Myfirstname Mysurname",
          "email": "",
          "tenancies": [
            {
              "id": "5d914499869caefed0f39eee",
              "name": "MyOrg",
              "code": "myorg",
              "role": "admin"
            },
            {
              "id": "5d9417aa869caefed0f7b4f9",
              "name": "ABCsafe",
              "code": "abcsafe",
              "role": "admin"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVsbGlvdCIsImV4cCI6MTU4MzgxNzA2N30.FdKD3QhPoNdWdbMfZ0bzCMTHluIt6HNP311F482K9AY"
      }
    ]
  }
}

Anmelden

Melden Sie sich mit der in der folgenden Tabelle aufgeführten Methode an.

HTTP-Methode Pfad Beschreibung Parameter

POST

/v2.1/auth/sign

Melden Sie sich als Benutzer an.

Keine

Erforderliche Body-Attribute für Anforderung: Benutzername (Zeichenfolge), New_password (Zeichenfolge)

Beispiel des Körpers anfordern:

{
  "username": "MyName",
  "password": "newPassword"
}

Beispiel des Antwortkörpers:

{
  "status": {
    "user_message": "Authentication succeeeded.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNzQwMH0._u_UyYrzg_RewF-9ClIGoKQhfZYWrixZYBrsj1kh1hI"
      }
    ]
  }
}