Invitar a usuarios a un equipo

Método HTTP POST

URL de llamada de API

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

Encabezado HTTP

  • Content-Type: application/json

  • Authorization: Bearer Token_ID_Claris

Cuerpo

  • users: Una lista de usuarios para invitar al equipo.

Para cada usuario:

  • email (cadena, necesaria): El ID de Claris o la dirección de correo electrónico de IdP externo del usuario al que vamos a invitar al equipo.

  • isIdpUser (Booleano): True si se invita a un usuario de IdP externo. De forma predeterminada será False.

  • isTeamManager (Booleano): True si se invita a un usuario como administrador de equipos. De forma predeterminada será False.

  • isLicensed (Booleano): True si se invita a un usuario como usuario con licencia. De forma predeterminada será False.

Ejemplo:

Copiar 
POST /public/organizations/ID_Equipo/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Token_ID_Claris
Copiar 
{
  "users": [
    {
      "email": "usuario1@ejemplo.com"
    },
    {
      "email": "usuario2@ejemplo.com",
      "isIdpUser": true
    },
    {
      "email": "usuario3@ejemplo.com",
      "isTeamManager": true
    },
    {
      "email": "usuario4@ejemplo.com",
      "isLicensed": true
    },
    {
      "email": "usuario5@ejemplo.com",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

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

Notas 

  • Si invita a múltiples usuarios y la invitación 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 se pueden añadir a cada solicitud es de 50.

  • El número máximo de invitaciones de usuario pendientes es de 50.

  • El número de usuarios con licencia en la solicitud no debería superar el número de usuarios con licencia para la suscripción.

  • No puede utilizar esta solicitud de API para cambiar los ajustes de isTeamManager ni de isLicensed si ya ha utilizado esta API o Claris Customer Console para configurar los ajustes para el mismo usuario. Para cambiar los ajustes, utilice Claris Customer Console.

  • No puede utilizar esta solicitud de API para eliminar usuarios de su equipo. Utilice Claris Customer Console para eliminar usuarios.