Crear y administrar invitaciones de usuarios

En esta página, se explica cómo realizar algunas operaciones fundamentales con la API de invitación de usuario de Cloud Identity.

Antes de comenzar

Nota: Antes de usar cualquiera de las API de Cloud Identity, debes configurar Cloud Identity. Consulta Configuración de Cloud Identity para obtener instrucciones.

Realiza las siguientes tareas antes de continuar con la información de esta página:

• Lee la descripción general de la API de invitación de usuario.
• Configura la API de invitación de usuario.

Determinación de la elegibilidad de la invitación

Como se indica en la descripción general, para que una cuenta de usuario pueda recibir una invitación, debe cumplir varios criterios. Puedes usar el método IsInvitableUser() para averiguar si una cuenta de usuario determinada es apta.

REST

Para verificar la elegibilidad de una cuenta de usuario, llama a customers.userinvitations.isInvitableUser() con el ID del cliente y la dirección de correo electrónico de la cuenta.

Solicitud de muestra

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:isInvitableUser

Recuperación de invitaciones de usuarios

La API de invitación de usuario proporciona métodos para recuperar una única invitación de usuario y recuperarlos todos. Cuando recuperas todas las invitaciones de usuarios, puedes filtrarlas de forma opcional por estado y establecer el orden de clasificación.

Recupera una invitación de usuario único

REST

Para recuperar una invitación de usuario único, llama a customers.userinvitations.get() con el ID de cliente y la dirección de correo electrónico de la cuenta.

Solicitud de muestra

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

Recuperación de una lista de invitaciones de usuarios

Todos los usuarios no administrados aparecen de forma automática como invitaciones en el estado NOT_YET_SENT hasta que el administrador o el usuario final actúen. Una vez que el usuario acepta una invitación, la cuenta ya no se considera no administrada.

• Si llamas a customers.userinvitations.list() con el estado en la solicitud, se mostrarán solo los usuarios cuya invitación esté en ese estado.
• Si llamas a customers.userinvitations.list() sin el estado en la solicitud, se mostrarán todas las invitaciones de usuarios.

Para verificar varios estados, agrega un operador or al filtro: state=='accepted'||state=='declined'

REST

Para recuperar una lista de invitaciones de usuario, llama a customers.userinvitations.list() con el ID de cliente y cualquier parámetro de consulta deseado para filtrar, ordenar y paginar los resultados. En el siguiente ejemplo, se muestra una lista de todos los usuarios no administrados, ordenados por la última hora de actualización en orden descendente.

Solicitud de muestra

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

Envío de invitaciones a usuarios

Las invitaciones a usuarios no se envían automáticamente a los usuarios aptos. Una vez que tengas una lista de los usuarios a los que deseas invitar, puedes usar el método customers.userinvitations.send(). También se creará una invitación si no existe.

REST

Para enviar un correo electrónico de invitación a un usuario, llama a customers.userinvitations.send() con el ID del cliente y la dirección de correo electrónico de la cuenta de usuario.

Solicitud de muestra

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:send

Cancela invitaciones de usuario

Las invitaciones de los usuarios 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 electrónico de la cuenta de usuario.

Solicitud de muestra

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:cancel