邀请资源类型

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

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

邀请进程使用以下流程：

  • 创建邀请
  • 将邀请发送至邀请的用户（包含邀请链接）
  • 受邀用户选择邀请链接，登录并兑换邀请，并创建表示受邀用户的用户实体完成
  • 兑现完成后，将用户重定向至指定页面

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

注意

使用作为邀请请求的一部分创建的外部用户资源上的 externalUserState 和 externalUserStateChangeDateTime 属性跟踪邀请状态。

方法

方法 返回类型 说明
创建邀请 邀请 写入 invitation 对象的属性和关系。

属性

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

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

关系

关系 类型 说明
invitedUser user 创建为邀请创建进程组成部分的用户。 只读
invitedUserSponsors directoryObject collection 受邀用户的发起人的用户或组。 发起人是负责来宾用户在租户中的权限以及使来宾用户的信息和访问保持最新状态的用户和组。

JSON 表示形式

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

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