Erstellen und Aktualisieren von Benutzern

Erstellen eines minimalen Benutzers

Das minimale Erstellungskriterium für einen Benutzer ist der username (Benutzername). Die folgende Anforderung erstellt beispielsweise einen Benutzer mit dem Benutzernamen „amartin“.

{
  "data": {
    "attributes": {
      "username": "amartin"
    }
  }
}

Im Folgenden finden Sie die Antwort-Nutzdaten.

POST /admin/v1/users
 
{
    "data": {
        "attributes": {
            "active": true,
            "displayName": "",
            "externalUser": false,
            "id": "cc:SVA-tE4oV6qcNvofjff8v",
            "username": "amartin",
            "vacationStatus": {
                "code": "atwork",
                "name": "At work"
            }
        },
        "checksum": "590697d4d0c3ccc1728d9f2d1d8c4051",
        "links": {
            "self": {
                "href": "/admin/v1/users/cc:SVA-tE4oV6qcNvofjff8v",
                "methods": [
                    "get",
                    "patch"
                ]
            }
        }
    }
}

Erstellen eines typischen Benutzers

Sie können zusätzliche Informationen zu einem Benutzer angeben, wie im Benutzerschema angegeben. Die folgenden Nutzdaten erstellen beispielsweise einen Benutzer mit den folgenden Attributen:

• Vorname: Adriana
• Nachname: Diaz
• Benutzername: adiaz
• Mitarbeiternummer: ACME-02027
• Rollen: Kontomanager (account_manager) und Schadenregulierer (adjuster)

POST /admin/v1/users

{
  "data": {
    "attributes": {
        "firstName": "Adriana",
        "lastName": "Diaz",
        "username": "adiaz",
        "employeeNumber": "ACME-02027",
        "roles" : [
            {
                "id": "account_manager"
            },
            {
                "id": "adjuster"
            }
        ]
    }
  }
}

Ändern der Benutzerrollenzuweisung

Sie können den PATCH /admin/v1/users/{userId}-Endpunkt verwenden, um einem vorhandenen Benutzer Rollen zuzuweisen oder die Zuweisung aufzuheben, indem Sie das roles-Array ändern.

Beachten Sie: Innerhalb der Cloud-API fügt das PATCHing eines Arrays die PATCH-Mitglieder nicht zu den bereits im Array vorhandenen Mitgliedern hinzu. Stattdessen ersetzt das PATCH die bestehenden Mitglieder durch die PATCH-Mitglieder. Wenn Sie möchten, dass ein PATCH zu einem Array additiv wirkt, müssen Sie zuerst die vorhandenen Mitglieder des Arrays ermitteln und dann im PATCH ein Array mit den vorhandenen sowie den hinzuzufügenden Mitgliedern angeben.

Als Beispiel folgende Annahme: Sie haben eine vorhandene Benutzerin namens Adriana Diaz mit der ID cc:111 und den folgenden Rollen:

Sie möchten dieser Benutzerin die Rolle „Teamleiter für Schadenfälle“ (claims_supervisor) hinzufügen. Dazu müssen Sie die folgenden Nutzdaten verwenden. (Beachten Sie, dass die Nutzdaten die vorhandenen Rollen und die neue Rolle angeben.)

PATCH /admin/v1/users/cc:111
      
{
  "data": {
    "attributes": {
      "roles": [
        {
          "id": "account_manager"
        },
        {
          "id": "adjuster"
        },
        {
          "id": "claims_supervisor"
        }
      ]
    }
  }
}