tipo de recurso de invitación

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Representa una invitación que se usa para agregar usuarios externos a una organización como parte de Microsoft Entra colaboración de negocio a negocio (Microsoft Entra B2B).

El proceso de invitación sigue el flujo siguiente:

• Se crea una invitación
• Se envía una invitación al usuario invitado (que contiene un vínculo de invitación)
• El usuario invitado selecciona en el vínculo de invitación, inicia sesión y canjea la invitación y la creación de la entidad de usuario que representa al usuario invitado se completa.
• Se redirige al usuario a una página específica después del canje

La creación de una invitación devuelve una dirección URL de canje en la respuesta (inviteRedeemUrl). La API create invitation puede enviar automáticamente un correo electrónico que contiene la dirección URL de canje al usuario invitado, estableciendo sendInvitationMessage en true. También puede personalizar el mensaje que se envía al usuario invitado. En su lugar, si desea enviar la dirección URL de canje a través de otros medios, puede establecer sendInvitationMessage en false y usar la dirección URL de canje de la respuesta para crear su propia comunicación. Actualmente, no hay ninguna API para realizar el proceso de canje. El usuario invitado tiene que seleccionar el vínculo inviteRedeemUrl enviado en la comunicación del paso anterior y pasar por el proceso de canje interactivo en un explorador. Una vez completado, el usuario invitado se convierte en un usuario externo de la organización.

Nota:

Se realiza un seguimiento del estado de la invitación mediante las propiedades externalUserState y externalUserStateChangeDateTime en el recurso de usuario externo creado como parte de la solicitud de invitación.

Métodos

Método	Tipo de valor devuelto	Descripción
Crear invitación	invitation	Escriba las propiedades y relaciones del objeto de invitación.

Propiedades

Propiedad	Tipo	Descripción
invitedUserDisplayName	String	Nombre para mostrar del usuario al que se invita.
invitedUserEmailAddress	String	Dirección de correo electrónico del usuario al que se invita. Obligatorio. No se permiten los siguientes caracteres especiales en la dirección de correo electrónico: Tilde (~) Signo de exclamación (!) Arroba (@) Signo de número (#) Signo de dólar ($) Signo de porcentaje (%) Acento circunflejo (^) Y comercial (&) Asterisco (*) Paréntesis (( )) Guión (-) Signo más (+) Signo igual (=) Corchetes ([ ]) Llaves ({ }) Barra diagonal inversa (\) Barra diagonal (/) Barra vertical (|) Punto y coma (;) Dos puntos (:) Comillas (") Corchetes angulares (< >) Signo de interrogación (?) Coma (,) Sin embargo, se aplican las siguientes excepciones: Se permite un punto (.) o un guion (-) en cualquier lugar en el nombre de usuario, excepto al principio o al final del nombre. Se permite un guion bajo (_) en cualquier lugar del nombre de usuario. Esto incluye el principio o el final del nombre.
invitedUserMessageInfo	invitedUserMessageInfo	Configuración adicional para el mensaje que se envía al usuario invitado, incluidos la personalización del texto del mensaje, el idioma y la lista de destinatarios CC.
inviteRedirectUrl	String	Se debe redirigir al usuario de la dirección URL una vez canjeada la invitación. Obligatorio.
inviteRedeemUrl	Cadena	La dirección URL que puede usar el usuario para canjear su invitación. Solo lectura.
invitedUserType	String	userType del usuario al que se invita. El valor predeterminado es Guest Puede invitar como Member si fuera administrador de la empresa. El valor predeterminado es false.
resetRedemption	Booleano	Restablezca el estado de canje del usuario y revite a un usuario mientras conserva su identificador de usuario, pertenencias a grupos y asignaciones de aplicaciones. Esta propiedad le permite permitir que un usuario inicie sesión con una dirección de correo electrónico diferente a la de la invitación anterior. Para obtener más información sobre el uso de esta propiedad, vea Restablecer el estado de canje de un usuario invitado (versión preliminar).
sendInvitationMessage	Boolean	Indica si se debe enviar un correo electrónico al usuario al que se invita. El valor predeterminado es false.
status	Cadena	El estado de la invitación. Valores posibles: PendingAcceptance, Completed, InProgressy Error

Relaciones

Relación	Tipo	Descripción
invitedUser	user	El usuario creado como parte de la creación de la invitación. Solo lectura
invitedUserSponsors	Colección directoryObject	Los usuarios o grupos que son patrocinadores del usuario invitado. Los patrocinadores son usuarios y grupos responsables de los privilegios de los usuarios invitados en el inquilino y de mantener actualizada la información y el acceso de los usuarios invitados.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "id": "String",
  "invitedUserDisplayName": "String",
  "invitedUserEmailAddress": "String",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "String",
  "inviteRedeemUrl": "String",
  "resetRedemption": false,
  "status": "String",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "String"
}