tipo de recurso de invitacióninvitation resource type

Representa una invitación que se usa para agregar usuarios externos a la organización.Represents an invitation that is used to add external users to an organization.

El proceso de invitación sigue el flujo siguiente:The invitation process uses the following flow:

  • Se crea una invitaciónAn invitation is created
  • Se envía una invitación al usuario invitado (que contiene un vínculo de invitación)An invitation is sent to the invited user (containing an invitation link)
  • El usuario invitado hace clic en el vínculo de la invitación, inicia sesión, canjea la invitación y finaliza la creación de la entidad de usuario que representa al usuario invitadoThe invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
  • Se redirige al usuario a una página específica después del canjeThe user is redirected to a specific page after redemption completes

Al crear una invitación, se devolverá una dirección URL de canje en la respuesta (inviteRedeemUrl). La API para crear la invitación puede enviar automáticamente un correo electrónico con la dirección URL de canje al usuario invitado, al establecer sendInvitationMessage en true. También puede personalizar el mensaje que se enviará al usuario invitado. En su lugar, si quiere 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 elaborar su propia comunicación. Actualmente, no hay ninguna API para realizar el proceso de canje. El usuario invitado tiene que hacer clic en el vínculo inviteRedeemUrl enviado en la comunicación en el paso anterior y pasar por el proceso de canje interactivo en un explorador. Una vez completado, el usuario invitado se convierte en usuario externo de la organización.Creating an invitation will return a redemption URL in the response (inviteRedeemUrl). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the sendInvitationMessage to true. You can also customize the message that will be sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the sendInvitationMessage to false and use the redeem URL from the response to craft your own communication. Currently, there is no API to perform the redemption process. The invited user has to click on the inviteRedeemUrl link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.

MétodosMethods

MétodoMethod Tipo de valor devueltoReturn Type DescripciónDescription
Crear invitaciónCreate invitation invitationinvitation Escriba las propiedades y relaciones del objeto de invitación.Write properties and relationships of invitation object.

PropiedadesProperties

PropiedadProperty TipoType DescripciónDescription
invitedUserDisplayNameinvitedUserDisplayName StringString Nombre para mostrar del usuario al que se invita.The display name of the user being invited.
invitedUserEmailAddressinvitedUserEmailAddress StringString Dirección de correo electrónico del usuario al que se invita. Necesario.The email address of the user being invited. Required.
invitedUserMessageInfoinvitedUserMessageInfo invitedUserMessageInfoinvitedUserMessageInfo 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.Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
sendInvitationMessagesendInvitationMessage BooleanBoolean Indica si se debe enviar un correo electrónico al usuario al que se invita o no. El valor predeterminado es false.Indicates whether an email should be sent to the user being invited or not. The default is false.
inviteRedirectUrlinviteRedirectUrl StringString La dirección URL a la que se redirigirá al usuario una vez que se canjee la invitación. Necesario.The URL user should be redirected to once the invitation is redeemed. Required.
inviteRedeemUrlinviteRedeemUrl StringString La dirección URL que puede usar el usuario para canjear su invitación. Solo lecturaThe URL user can use to redeem his invitation. Read-Only
invitedUserTypeinvitedUserType StringString userType del usuario al que se invita.The userType of the user being invited. El valor predeterminado es Guest.By default, this is Guest. Puede invitar como Member si es administrador de una empresa.You can invite as Member if you are a company administrator.
statusstatus StringString El estado de la invitación. Valores posibles: PendingAcceptance, Completed, InProgress y ErrorThe status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error

RelacionesRelationships

RelaciónRelationship TipoType DescripciónDescription
invitedUserinvitedUser UserUser El usuario creado como parte de la creación de la invitación. Solo lecturaThe user created as part of the invitation creation. Read-Only

Representación JSONJSON representation

Aquí tiene una representación JSON del recursoHere is a JSON representation of the resource

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