Ajouter des utilisateurs à un groupe

Méthode HTTP

PUT

URL d'appel API

https://api-cp-global.ifmcloud.com/public/organizations/ID_équipe/groups/users

En-tête HTTP
  • Content-Type: application/json
  • Authorization: Bearer Jeton_Claris_ID
Corps
  • groupName (chaîne, obligatoire) : nom du groupe.
  • users : ensemble répertoriant les utilisateurs à ajouter au groupe.

Pour chaque utilisateur :

  • email (chaîne, obligatoire) : adresse e-mail de l'utilisateur à ajouter au groupe.
  • isIdpUser (valeur booléenne) : « true » si vous ajoutez un utilisateur de fournisseur d'identité au groupe. La valeur par défaut est « false ».

Exemple :

Copier 
PUT /public/organizations/ID_équipe/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Jeton_Claris_ID
Copier 
{
  "groupName": "Exemple de groupe",
 
  "users": [
    {
      "email": "utilisateur1@exemple.com"
    },
    {
      "email":"utilisateur2@exemple.com",
      "isIdpUser": true
    },
    {
      "email":"utilisateur3@exemple.com"
    }
  ]
}
Paramètres Aucun
Corps de réponse
  • code (chaîne) : code d'erreur en cas d'erreur ; « OK » si aucune erreur.
  • message (chaîne) : message d'erreur en cas d'erreur ; « null » si aucune erreur.
  • succeeded : ensemble répertoriant les requêtes ayant réussi.
  • failed : ensemble répertoriant les requêtes ayant échoué.
  • requestId : ID de requête API utilisé à titre de référence.

Exemple :

Copier 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "utilisateur1@exemple.com",
        "isIdpUser": false,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "utilisateur2@exemple.com",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "utilisateur2@exemple.com is not a valid email."
    }
  ],
  "requestId": "{ID_requête}"
}

Remarques 

  • Si vous ajoutez plusieurs utilisateurs à un groupe et que les requêtes réussissent que pour certains utilisateurs, la requête API est considérée comme réussie. Des informations détaillées à propos des requêtes ayant réussi et échoué sont renvoyées.
  • Le nombre maximum d'utilisateurs pouvant être ajoutés dans chaque requête est de 100.
  • Vous ne pouvez pas utiliser cette requête API pour inviter des utilisateurs à rejoindre un groupe externe.