通过

邀请资源类型

  • 项目

命名空间：microsoft.graph

表示一个邀请，该邀请用于将外部用户添加到组织，作为Microsoft Entra 企业到企业 (Microsoft Entra B2B) 协作的一部分。

邀请进程使用以下流程：

  • 已创建邀请。
  • 包含邀请链接的邀请将发送给受邀用户。
  • 受邀用户选择邀请链接、登录并兑换邀请，并创建表示受邀用户的用户实体。
  • 兑换完成后，用户将被重定向到特定页面。

创建邀请将返回响应中的兑换 URL， (inviteRedeemUrl) 。 创建邀请 API 可以将 sendInvitationMessagetrue设置为 ，自动向受邀用户发送包含兑换 URL 的电子邮件。 还可以自定义发送给受邀用户的消息。 相反，如果要通过其他方式发送兑换 URL，可以将 sendInvitationMessage 设置为 false ，并使用响应中的兑换 URL 来创建自己的通信。 目前，没有 API 可用于执行兑换过程。 受邀用户必须选择通信中发送的 inviteRedeemUrl 链接，并在浏览器中完成交互式兑换过程。 该过程完成后，受邀用户将成为组织中的外部用户。

方法

方法 返回类型 说明
创建 邀请 创建邀请对象。

属性

属性 类型 说明
invitedUserDisplayName String 被邀请的用户的显示名称。
invitedUserEmailAddress String 被邀请的用户的电子邮件地址。 必需。 电子邮件地址中不允许使用以下特殊字符：
  • 波形符 (~)
  • 感叹号 (!)
  • 井号 (#)
  • 美元符号 ($)
  • 百分号 (%)
  • 扬抑符 (^)
  • 与号 (&)
  • 星号 (*)
  • 圆括号 (( ))
  • 加号 (+)
  • 等号 (=)
  • 方括号 ([ ])
  • 大括号 ({ })
  • 反斜杠 (\)
  • 斜杠符号 (/)
  • 竖线 (\|)
  • 分号 (;)
  • 冒号 (:)
  • 引号 (")
  • 尖括号 (< >)
  • 问号 (?)
  • 逗号 (,)

但是，存在下列例外情况：
  • 允许在用户名中的任何位置使用句点 (.) 或连字符 (-)，但名称的开头或结尾除外。
  • 下划线 (_) 在用户名中的任何位置（包括名称的开头或末尾）都允许使用。
invitedUserMessageInfo invitedUserMessageInfo 包含要发送给受邀用户的邮件的配置，包括自定义邮件文本、语言和抄送收件人列表。
invitedUserType String 被邀请的用户的 userType。 默认情况下，此操作为 Guest。 你可以邀请你，就像你是公司管理员一样 Member 。
inviteRedirectUrl String 在兑换邀请后，用户应重定向到的 URL。 必填。
inviteRedeemUrl String 用户可用于兑换邀请的 URL。 只读。
resetRedemption 布尔值 重置用户的兑换状态并重新邀请用户，同时保留其用户标识符、组成员身份和应用分配。 此属性允许用户使用与上一个邀请中的电子邮件地址不同的电子邮件地址登录。 当为 时 true，需要 invitedUser/ID 关系。 有关使用此属性的详细信息，请参阅 重置来宾用户的兑换状态。
sendInvitationMessage Boolean 指示电子邮件是否应发送至邀请的用户。 默认值为 false。
status String 邀请的状态。 可能的值为： PendingAcceptance、 Completed、 InProgress和 Error。

关系

关系 类型 说明
invitedUser 用户 创建为邀请创建进程组成部分的用户。 此为只读属性。 请求正文中需要 id 属性才能重置兑换状态。
invitedUserSponsors directoryObject collection 受邀用户的发起人的用户或组。 发起人是负责来宾用户在租户中的权限以及使来宾用户的信息和访问保持最新状态的用户和组。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

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