Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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:
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/writer@altostrat.com: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/writer@altostrat.com
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.
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/writer@altostrat.com:send
Cancela invitaciones de usuario
Las invitaciones de los usuarios se pueden cancelar hasta que se acepten o rechacen.
Llama al método customers.userinvítions.cancel() para cancelar una invitación.
REST
Para cancelar una invitación de usuario, llama a customers.userinvítions.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/writer@altostrat.com:cancel
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[[["\u003cp\u003eThis page provides guidance on using the Cloud Identity User Invitation API to manage user invitations, including checking eligibility, retrieving, sending, and canceling them.\u003c/p\u003e\n"],["\u003cp\u003eYou can verify if a user account is eligible for an invitation using the \u003ccode\u003eIsInvitableUser()\u003c/code\u003e method, which requires the customer ID and the user's email address.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows retrieval of single or multiple user invitations, with the option to filter by state and sort the results when retrieving a list of invitations.\u003c/p\u003e\n"],["\u003cp\u003eUser invitations are not automatically sent; you must use the \u003ccode\u003ecustomers.userinvitations.send()\u003c/code\u003e method to send an invitation email to a specific user, which also creates the invitation if one does not already exist.\u003c/p\u003e\n"],["\u003cp\u003eUser invitations can be canceled until they are accepted or declined, by using the \u003ccode\u003ecustomers.userinvitations.cancel()\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# Creating and managing user invitations\n======================================\n\nThis page explains how to perform some fundamental operations with the\nCloud Identity User Invitation API.\n\nBefore you begin\n----------------\n\n**Note:** Before you use any of the Cloud Identity APIs, you must set up\nCloud Identity. See [Setting up Cloud Identity](/identity/docs/set-up-cloud-identity-admin)\nfor instructions.\n\nPerform the following tasks before proceeding with the information on this page:\n\n- Read the [User Invitation API overview](/identity/docs/concepts/overview-user-invitations).\n- Set up the [User Invitation API](/identity/docs/how-to/setup-user-invitations).\n\nDetermining invitation eligibility\n----------------------------------\n\nAs noted in the [overview](/identity/docs/concepts/overview-user-invitations),\nto be invited a user account must meet multiple criteria. You can use the\n[`IsInvitableUser()`](/identity/docs/reference/rest/v1/customers.userinvitations/isInvitableUser)\nmethod to find out if a given user account is eligible. \n\n### REST\n\nTo check the eligibility of a user account, call\n[`customers.userinvitations.isInvitableUser()`](/identity/docs/reference/rest/v1/customers.userinvitations/isInvitableUser)\nwith the customer ID and the account's email address.\n\n**Sample request** \n\n GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser\n\nRetrieving user invitations\n---------------------------\n\nThe User Invitation API provides methods for retrieving a single user\ninvitation and retrieving all of them. When retrieving all user invitations,\nyou can optionally filter them by state and set the sorting order.\n\n### Retrieving a single user invitation\n\n### REST\n\nTo retrieve a single user invitation, call\n[`customers.userinvitations.get()`](/identity/docs/reference/rest/v1/customers.userinvitations/get)\nwith the customer ID and the account's email address.\n\n**Sample request** \n\n GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com\n\n### Retrieving a list of user invitations\n\nAll unmanaged users appear automatically as invitations in the `NOT_YET_SENT`\nstate until otherwise acted upon by either the admin or the end user. Once an\ninvitation is accepted by the user, the account is no longer considered\nunmanaged.\n\n- If you call [`customers.userinvitations.list()`](/identity/docs/reference/rest/v1/customers.userinvitations/list) with the state in the request, it will return only users whose invitation is in that state.\n- If you call [`customers.userinvitations.list()`](/identity/docs/reference/rest/v1/customers.userinvitations/list) without the state in the request, it will return all user invitations.\n\nYou can check for multiple states by adding an `or` operator in the filter:\n`state=='accepted'||state=='declined'` \n\n### REST\n\nTo retrieve a list of user invitations, call\n[`customers.userinvitations.list()`](/identity/docs/reference/rest/v1/customers.userinvitations/list)\nwith the customer ID and any desired query parameters to filter, order, and\npaginate the results. The following example returns a list of all unmanaged\nusers, ordered by the last updated time in descending order.\n\n**Sample request** \n\n GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'\n\nSending user invitations\n------------------------\n\nUser invitations are not automatically sent to eligible users. Once you have a\nlist of the users you want to invite, you can use the\n[`customers.userinvitations.send()`](/identity/docs/reference/rest/v1/customers.userinvitations/send) method.\nThis will also create an invitation if it doesn't exist. \n\n### REST\n\nTo send a user invitation email to a user, call\n[`customers.userinvitations.send()`](/identity/docs/reference/rest/v1/customers.userinvitations/send)\nwith the customer ID and the user account's email address.\n\n**Sample request** \n\n POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:send\n\nCanceling user invitations\n--------------------------\n\nUser invitations can be canceled until they are either accepted or declined.\nCall the\n[customers.userinvitations.cancel()](/identity/docs/reference/rest/v1/customers.userinvitations/cancel)\nmethod to cancel an invitation. \n\n### REST\n\nTo cancel a user invitation, call\n[customers.userinvitations.cancel()](/identity/docs/reference/rest/v1/customers.userinvitations/cancel)\nwith the customer ID and the user account's email address.\n\n**Sample request** \n\n POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:cancel"]]
