Inviter des utilisateurs à rejoindre une équipe

Méthode HTTP POST

URL d'appel API

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

En-tête HTTP

  • Content-Type: application/json

  • Authorization: Bearer Jeton_Claris_ID

Corps

  • users : ensemble répertoriant les utilisateurs à inviter à rejoindre l'équipe.

Pour chaque utilisateur :

  • email (chaîne, obligatoire) : adresse e-mail du compte Claris ID ou du fournisseur d'identité externe de l'utilisateur à inviter à rejoindre l'équipe.

  • isIdpUser (valeur booléenne) : « true » si vous invitez un utilisateur de fournisseur d'identité externe. La valeur par défaut est « false ».

  • isTeamManager (valeur booléenne) : « true » si vous invitez un utilisateur comme chef d'équipe. La valeur par défaut est « false ».

  • isLicensed (valeur booléenne) : « true » si vous invitez un utilisateur comme utilisateur avec licence. La valeur par défaut est « false ».

Exemple :

Copier 
POST /public/organizations/ID_équipe/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Jeton_Claris_ID
Copier 
{
  "users": [
    {
      "email": "utilisateur1@exemple.com"
    },
    {
      "email": "utilisateur2@exemple.com",
      "isIdpUser": true
    },
    {
      "email": "utilisateur3@exemple.com",
      "isTeamManager": true
    },
    {
      "email": "utilisateur4@exemple.com",
      "isLicensed": true
    },
    {
      "email": "utilisateur5@exemple.com",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

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,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "utilisateur2@exemple.com",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "EmailNotValid",
      "message": "utilisateur2@exemple.com is not a valid email."
    }
  ],
  "requestId": "{ID_requête}"
}

Remarques 

  • Si vous invitez plusieurs utilisateurs et que les invitations 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 50.

  • Le nombre maximum d'invitations utilisateur en attente est de 50.

  • Le nombre d'utilisateurs avec licence dans la requête ne doit pas dépasser le nombre d'utilisateurs avec licence pour l'abonnement.

  • Vous ne pouvez pas utiliser cette requête API pour modifier les paramètres isTeamManager et isLicensed si vous avez déjà utilisé cette API ou la Claris Customer Console pour configurer les paramètres pour un même utilisateur. Utilisez la Claris Customer Console pour modifier ces paramètres.

  • Vous ne pouvez pas utiliser cette requête API pour supprimer des utilisateurs de votre équipe. Utilisez la Claris Customer Console pour supprimer des utilisateurs.