Aggiungi utenti a un gruppo

Metodo HTTP

PUT

URL chiamata API

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

Intestazione HTTP
  • Content-Type: application/json
  • Authorization: Bearer Token_ID_Claris
Corpo
  • groupName (stringa, richiesto): il nome del gruppo.
  • users: elenco degli utenti da aggiungere al gruppo.

Per ogni utente:

  • email (stringa, richiesto): l'indirizzo e-mail degli utenti da aggiungere al gruppo.
  • isIdpUser (Booleano): True in caso di aggiunta di un utente IdP esterno al gruppo. Il valore predefinito è False.

Esempio:

Copia 
PUT /public/organizations/ID_Team/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Token_ID_Claris
Copia 
{
  "groupName": "Gruppo esempio",
 
  "users": [
    {
      "email": "utente1@esempio.com"
    },
    {
      "email": "utente2@esempio.com",
      "isIdpUser": true
    },
    {
      "email": "utente3@esempio.com"
    }
  ]
}
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,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "utente2@esempio.com",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "utente2@esempio.com non è un'e-mail valida."
    }
  ],
  "requestId": "{Request_ID}"
}

Note 

  • Se si aggiungono più utenti a un gruppo e l'aggiunta 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 è 100.
  • Non è possibile utilizzare questa richiesta API per invitare gli utenti in un gruppo esterno.