Benutzer in ein Team einladen

HTTP-Methode POST

API-Aufruf-URL

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

HTTP-Header

  • Content-Type: application/json

  • Authorization: Bearer Claris_ID_Token

Hauptbereich

  • users: Ein Array mit einer Liste von Benutzern, die in das Team eingeladen werden.

Für jeden Benutzer:

  • email (Zeichenfolge, erforderlich): Die Claris-ID oder externe IdP-E-Mail-Adresse des Benutzers, der in das Team eingeladen werden soll.

  • isIdpUser (boolesch): True, wenn ein externer IdP-Benutzer eingeladen wird. Die Voreinstellung ist False.

  • isTeamManager (boolesch): True, wenn ein Benutzer als Teammanager eingeladen wird. Die Voreinstellung ist False.

  • isLicensed (boolesch): True, wenn ein Benutzer als lizenzierter Benutzer eingeladen wird. Die Voreinstellung ist False.

Beispiel:

Kopieren 
POST /public/organizations/Team_ID/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
Kopieren 
{
  "users": [
    {
      "email": "benutzer1@beispiel.de"
    },
    {
      "email": "benutzer2@beispiel.de",
      "isIdpUser": true
    },
    {
      "email": "benutzer3@beispiel.de",
      "isTeamManager": true
    },
    {
      "email": "benutzer4@beispiel.de",
      "isLicensed": true
    },
    {
      "email": "benutzer5@beispiel.de",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

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,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "benutzer2@beispiel.de",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "EmailNotValid",
      "message": "benutzer2@beispiel.de ist keine gültige E-Mail."
    }
  ],
  "requestId": "{Request_ID}"
}

Hinweise 

  • Wenn Sie mehrere Benutzer einladen 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 50.

  • Die maximale Anzahl der ausstehenden Benutzereinladungen beträgt 50.

  • Die Anzahl der lizenzierten Benutzer in der Request darf die Anzahl der lizenzierten Benutzer für das Abonnement nicht überschreiten.

  • Sie können diese API-Request nicht verwenden, um isTeamManager- und isLicensed-Einstellungen zu ändern, wenn Sie diese API oder Claris Customer Console bereits verwendet haben, um die Einstellung für denselben Benutzer zu konfigurieren. Um die Einstellung zu ändern, verwenden Sie Claris Customer Console.

  • Sie können diese API-Request nicht verwenden, um Benutzer aus Ihrem Team zu entfernen. Verwenden Sie Claris Customer Console, um Benutzer zu entfernen.