Benutzer zu einer Gruppe hinzufügen

HTTP-Methode

PUT

API-Aufruf-URL

https://api-cp-global.ifmcloud.com/public/organizations/Team_ID/groups/users

HTTP-Header
  • Content-Type: application/json
  • Authorization: Bearer Claris_ID_Token
Hauptbereich
  • groupName (Zeichenfolge, erforderlich): Der Name der Gruppe.
  • users: Ein Array mit einer Liste von Benutzern, die der Gruppe hinzugefügt werden.

Für jeden Benutzer:

  • email (Zeichenfolge, erforderlich): Die E-Mail-Adresse der Benutzer, die der Gruppe hinzugefügt werden sollen.
  • isIdpUser (boolesch): True, wenn ein externer IdP-Benutzer der Gruppe hinzugefügt wird. Die Voreinstellung ist False.

Beispiel:

Kopieren 
PUT /public/organizations/Team_ID/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
Kopieren 
{
  "groupName": "Beispielgruppe",
 
  "users": [
    {
      "email": "benutzer1@beispiel.de"
    },
    {
      "email":"benutzer2@beispiel.de",
      "isIdpUser": true
    },
    {
      "email":"benutzer3@beispiel.de"
    }
  ]
}
Parameter Keine
Antwortteil
  • code (Zeichenfolge): Der Fehlercode, wenn es Fehler gibt; OK, wenn es keine Fehler gibt.
  • message (Zeichenfolge): Die Fehlermeldung, wenn es Fehler gibt; null, wenn es keine Fehler gibt.
  • succeeded: Ein Array mit Abfragen, die erfolgreich waren.
  • failed: Ein Array mit Abfragen, die fehlgeschlagen sind.
  • requestId: Die API-Request-ID, die als Referenz verwendet wird.

Beispiel:

Kopieren 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "benutzer1@beispiel.de",
        "isIdpUser": false,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "benutzer2@beispiel.de",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "benutzer2@beispiel.de ist keine gültige E-Mail."
    }
  ],
  "requestId": "{Request_ID}"
}

Hinweise 

  • Wenn Sie mehrere Benutzer zu einer Gruppe hinzufügen und die Einladung nur für einige der Benutzer erfolgreich ist, gilt die API-Request als erfolgreich. Sie liefert detaillierte Informationen über erfolgreiche und fehlgeschlagene Requests.
  • Die maximale Anzahl der Benutzer, die jeder Request hinzugefügt werden können, beträgt 100.
  • Sie können diese API-Request nicht verwenden, um Benutzer zu einer externen Gruppe hinzuzufügen.