tipo de recurso de invitación

  • Artículo

Espacio de nombres: microsoft.graph

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

El proceso de invitación sigue el flujo siguiente:

  • Se crea una invitación.
  • Una invitación que contiene un vínculo de invitación se envía al usuario invitado.
  • El usuario invitado selecciona el vínculo de invitación, inicia sesión y canjea la invitación y se crea la entidad de usuario que representa al usuario invitado.
  • El usuario se redirige a una página específica una vez completado el canje.

La creación de una invitación devuelve una dirección URL de canje en la respuesta (inviteRedeemUrl). La API de creación de invitación 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 sendInvitationMessagefalse en y usar la dirección URL de canje de la respuesta para crear su propia comunicación. Actualmente, no hay ninguna API disponible para realizar el proceso de canje. El usuario invitado tiene que seleccionar el vínculo inviteRedeemUrl enviado en la comunicación y pasar por el proceso de canje interactivo en un explorador. Cuando se completa el proceso, el usuario invitado se convierte en un usuario externo de la organización.

Métodos

Método Tipo de valor devuelto Descripción
Crear invitation Cree un 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 (!)
  • Signo de número (#)
  • Signo de dólar ($)
  • Signo de porcentaje (%)
  • Acento circunflejo (^)
  • Y comercial (&)
  • Asterisco (*)
  • Paréntesis (( ))
  • 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 carácter de subrayado (_) en cualquier parte del nombre de usuario, incluido al principio o al final del nombre.
invitedUserMessageInfo invitedUserMessageInfo Contiene la configuración del mensaje que se envía al usuario invitado, incluida la personalización del texto del mensaje, el idioma y la lista de destinatarios cc.
invitedUserType String userType del usuario al que se invita. El valor predeterminado es Guest Puede invitar como Member si fuera administrador de la empresa.
inviteRedirectUrl String Dirección URL a la que se debe redirigir al usuario después de canjear la invitación. Obligatorio.
inviteRedeemUrl Cadena La dirección URL que puede usar el usuario para canjear su invitación. Solo lectura.
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. Cuando truees , se requiere la relación deid. de usuario invitado/. Para obtener más información sobre el uso de esta propiedad, vea Restablecer el estado de canje de un usuario invitado.
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. Los valores posibles son PendingAcceptance, Completed, InProgress y Error

Relaciones

Relación Tipo Descripción
invitedUser user El usuario creado como parte de la creación de la invitación. Solo lectura. La propiedad id es necesaria en el cuerpo de la solicitud para restablecer un estado de canje.
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.

{
  "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"
}