Invita utenti in un team

Metodo HTTP POST

URL chiamata API

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

Intestazione HTTP

  • Content-Type: application/json

  • Authorization: Bearer Token_ID_Claris

Corpo

  • users: elenco di utenti da invitare nel team.

Per ogni utente:

  • e-mail (stringa, richiesto): l'ID Claris o l'indirizzo e-mail dell'IdP esterno dell'utente da invitare nel team.

  • isIdpUser (Booleano): True in caso di invito di un utente IdP esterno. Il valore predefinito è False.

  • isTeamManager (Booleano): True in caso di invito di un utente come responsabile del team. Il valore predefinito è False.

  • isLicensed (Booleano): True in caso di invito di un utente come utente con licenza. Il valore predefinito è False.

Esempio:

Copia 
POST /public/organizations/ID_Team/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Token_ID_Claris
Copia 
{
  "users": [
    {
      "email": "utente1@esempio.com"
    },
    {
      "email": "utente2@esempio.com",
      "isIdpUser": true
    },
    {
      "email": "utente3@esempio.com",
      "isTeamManager": true
    },
    {
      "email": "utente4@esempio.com",
      "isLicensed": true
    },
    {
      "email": "utente5@esempio.com",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

Parametri

Nessuno

Risposta corpo

  • code (stringa): il codice di errore se vi sono errori; OK se non vi sono errori.

  • message (stringa): il messaggio di errore se vi sono errori; null se non vi sono errori.

  • succeeded: un elenco di richieste riuscite.

  • failed: un elenco di richieste non riuscite.

  • requestId: l'ID richiesta API utilizzato per riferimento.

Esempio:

Copia 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "utente1@esempio.com",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "utente2@esempio.com",
        "isIdpUser": false,
        "isTeamManager": false,
        "isLicensed": true
      },
      "code": "EmailNotValid",
      "message": "utente2@esempio.com non è un'e-mail valida."
    }
  ],
  "requestId": "{Request_ID}"
}

Note 

  • Se si invitano più utenti e l'invito va a buon fine solo per alcuni di essi, la richiesta API viene considerata come riuscita. Restituisce informazioni dettagliate sulle richieste riuscite e non riuscite.

  • Il numero massimo di utenti che è possibile aggiungere a ogni richiesta è 50.

  • Il numero massimo di inviti utente in sospeso è 50.

  • Il numero degli utenti con licenza nella richiesta non deve superare il numero degli utenti con licenza per l'abbonamento.

  • Non è possibile utilizzare questa richiesta API per modificare le impostazioni isTeamManager e isLicensed se questa API o la Claris Customer Console sono già state utilizzate per configurare l'impostazione per lo stesso utente. Per modificare l'impostazione, utilizzare la Claris Customer Console.

  • Non è possibile utilizzare questa richiesta API per rimuovere gli utenti dal team. Per rimuovere gli utenti utilizzare la Claris Customer Console.