Benutzer verwalten

  • Updated on Aug 1, 2023
  • 1 minute(s) read
Prev Next

In den folgenden Abschnitten wird erläutert, wie Sie Benutzerrollen für Ihre Organisation erhalten und neue Benutzer hinzufügen können.

Benutzerrollen für Ihre Organisation erhalten

Die ID der Benutzerrolle ist ein erforderlicher Parameter für den API-Aufruf, um einen neuen Benutzer hinzuzufügen. Stellen Sie die folgende GET-Anfrage, um eine Liste mit den in Ihrer Organisation verfügbaren Benutzerrollen zu erhalten:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  'https://<your_company>.manage.iotium.io/api/v2/role' \
  | jq '.results | .[]' | jq '{role_id: .id, name: .name}'

Die Antwort beinhaltet die Namen und IDs aller in Ihrer Organisation verfügbaren Benutzerrollen:

{
  "role_id": "<your_readonly_role_id>",
  "name": "Read Only"
}
{
  "role_id": "<your_admin_role_id>",
  "name": "Admin"
}

Einen neuen Benutzer hinzufügen

Stellen Sie die folgende POST-Anfrage mit den Parametern des Anfrage-Bodys, um Ihrer Organisation ein neues Benutzerkonto hinzuzufügen:

NameTypeErforderlich oder OptionalBeschreibung

name

string

Erforderlich

Name des neuen Benutzers.

E-Mail-Adresse

string

Erforderlich

E-Mail-Adresse des neuen Benutzers.

Wenn Sie einen neuen Benutzer hinzufügen, erhält dieser automatisch eine E-Mail mit einem Link, um seine E-Mail-Adresse zu bestätigen. Neue Benutzer können sich erst anmelden, wenn sie ihre E-Mail-Adresse bestätigt haben.

Passwort

string

Erforderlich

Passwort für den neuen Benutzer.

Nachdem neue Benutzer ihre E-Mail-Adresse bestätigt und sich angemeldet haben, werden sie bei der ersten Anmeldung aufgefordert, ihr Passwort zu ändern.

Rollen

Array

Erforderlich

Liste aus Rollen für den neuen Benutzer.

In diesem Beispiel hat der neue Benutzer eine Administratorrolle.

curl -X POST \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"name":"<your_newuser_name>", \
       "email":"<your_newuser_email>", \
       "password":"<your_newuser_password>", \
       "roles":["<your_admin_role_id>"]}' \
  'https://<your_company>.manage.iotium.io/api/v1/user' \
  | jq '{id:.id, name:.name, role:.roles}'

Die Antwort beinhaltet den Namen und die ID des neuen Benutzers und den Namen und die ID der Benutzerrolle:

{
  "id": "<your_newuser_id>",
  "name": "<your_newuser_name>",
  "role": [
    {
      "id": "<your_admin_role_id>",
      "name": "Admin"
    }
  ]
}