Crear y gestionar invitaciones de usuarios
En esta página se explica cómo realizar algunas operaciones fundamentales con la API User Invitation de Cloud Identity.
Antes de empezar
Nota: Antes de usar cualquiera de las APIs de Cloud Identity, debes configurar Cloud Identity. Consulta las instrucciones en el artículo Configurar Cloud Identity.
Realiza las siguientes tareas antes de continuar con la información de esta página:
- Consulta la información general sobre la API User Invitation.
- Configura la API User Invitation.
Determinar si se cumplen los requisitos para recibir una invitación
Como se indica en la descripción general, para poder invitar a una cuenta de usuario, esta debe cumplir varios criterios. Puedes usar el método
IsInvitableUser()
para saber si una cuenta de usuario determinada cumple los requisitos.
REST
Para comprobar si una cuenta de usuario cumple los requisitos, llama a
customers.userinvitations.isInvitableUser()
con el ID de cliente y la dirección de correo de la cuenta.
Solicitud de ejemplo
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser
Recuperando invitaciones de usuario
La API User Invitation proporciona métodos para obtener una sola invitación de usuario o todas ellas. Al recuperar todas las invitaciones de usuario, puedes filtrarlas por estado y definir el orden de clasificación.
Recuperar una sola invitación de usuario
REST
Para recuperar una invitación de un solo usuario, llama a
customers.userinvitations.get()
con el ID de cliente y la dirección de correo de la cuenta.
Solicitud de ejemplo
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com
Obtener una lista de invitaciones de usuario
Todos los usuarios no gestionados aparecen automáticamente como invitaciones en el estado NOT_YET_SENT
hasta que el administrador o el usuario final tomen alguna medida. Una vez que el usuario acepta una invitación, la cuenta deja de considerarse no gestionada.
- Si llamas a
customers.userinvitations.list()con el estado en la solicitud, solo se devolverán los usuarios cuya invitación esté en ese estado. - Si llamas a
customers.userinvitations.list()sin el estado en la solicitud, se devolverán todas las invitaciones de usuario.
Puedes comprobar varios estados añadiendo un operador or al filtro:
state=='accepted'||state=='declined'
REST
Para obtener una lista de invitaciones de usuario, llama a
customers.userinvitations.list()
con el ID de cliente y los parámetros de consulta que quieras para filtrar, ordenar y
paginar los resultados. En el siguiente ejemplo se devuelve una lista de todos los usuarios no gestionados, ordenada por la última hora de actualización en orden descendente.
Solicitud de ejemplo
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'
Enviar invitaciones de usuario
Las invitaciones de usuario no se envían automáticamente a los usuarios aptos. Una vez que tengas una lista de los usuarios a los que quieras invitar, puedes usar el método customers.userinvitations.send().
También se creará una invitación si no existe.
REST
Para enviar un correo de invitación a un usuario, llama a
customers.userinvitations.send()
con el ID del cliente y la dirección de correo de la cuenta del usuario.
Solicitud de ejemplo
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:send
Cancelar invitaciones de usuario
Las invitaciones de usuario se pueden cancelar hasta que se acepten o rechacen. Llama al método customers.userinvitations.cancel() para cancelar una invitación.
REST
Para cancelar una invitación de usuario, llama a customers.userinvitations.cancel() con el ID de cliente y la dirección de correo de la cuenta de usuario.
Solicitud de ejemplo
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:cancel