Añadir usuarios a un grupo

Método HTTP

PUT

URL de llamada de API

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

Encabezado HTTP
  • Content-Type: application/json
  • Authorization: Bearer Token_ID_Claris
Cuerpo
  • groupName (cadena, necesaria): El nombre del grupo.
  • users: Una lista de usuarios para añadir al grupo.

Para cada usuario:

  • email (cadena, necesaria): La dirección de correo electrónico de los usuarios para añadir al grupo.
  • isIdpUser (Booleano): True si se añade un usuario IdP externo al grupo. De forma predeterminada será False.

Ejemplo:

Copiar 
PUT /public/organizations/ID_Equipo/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Token_ID_Claris
Copiar 
{
  "groupName": "Ejemplo de grupo",
 
  "users": [
    {
      "email": "usuario1@ejemplo.com"
    },
    {
      "email": "usuario2@ejemplo.com",
      "isIdpUser": true
    },
    {
      "email": "usuario3@ejemplo.com"
    }
  ]
}
Parámetros Ninguno
Cuerpo de respuesta
  • code (cadena): El código de error si hay errores; "OK" si no hay errores.
  • message (cadena): El mensaje de error si hay errores; "null" si no hay errores.
  • succeeded: Una lista de solicitudes exitosas.
  • failed: Una lista de solicitudes fallidas.
  • requestId: El ID de solicitud de API utilizado para referencia.

Ejemplo:

Copiar 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "usuario1@ejemplo.com",
        "isIdpUser": false,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "usuario2@ejemplo.com",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "usuario2@ejemplo.com is not a valid email."
    }
  ],
  "requestId": "{Solicitud_ID}"
}

Notas 

  • Si añade múltiples usuarios a un grupo y la solicitud solo tiene éxito con algunos de los usuarios, la solicitud de la API se considera exitosa. Devuelve información detallada sobre las solicitudes que tuvieron éxito y las que resultaron fallidas.
  • El número máximo de usuarios que añadir a cada solicitud es 100.
  • No puede utilizar esta solicitud de API para invitar a usuarios a un grupo externo.