命名空间:microsoft.graph
表示用于将外部用户添加到组织的邀请。
邀请进程使用以下流程:
- 创建邀请
- 将邀请发送至邀请的用户(包含邀请链接)
- 邀请的用户单击邀请链接、登录并兑现邀请和创建用户实体表示邀请的用户完成操作
- 兑现完成后,将用户重定向至指定页面
创建邀请会在响应中返回兑现 URL (inviteRedeemUrl)。通过将 sendInvitationMessage 设置为 true,创建邀请 API 可以自动向邀请的用户发送包含兑现 URL 的电子邮件。还可以自定义要发送至邀请的用户的邮件。反之,如果想要通过一些其他的方法发送兑现 URL,则可以将 sendInvitationMessage 设置为 false,然后使用响应中的兑现 URL 创建自己的通信。目前没有可以执行兑现进程的 API。邀请的用户必须单击在上述步骤中的通信中发送的 inviteRedeemUrl 链接,并在浏览器中进行交互式兑现流程。完成后,邀请的用户即成为组织中的外部用户。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 创建邀请 | 邀请 | 写入 invitation 对象的属性和关系。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| invitedUserDisplayName | String | 被邀请的用户的显示名称。 |
| invitedUserEmailAddress | String | 被邀请的用户的电子邮件地址。 必需。 电子邮件地址中不允许使用以下特殊字符:<ul><li>波形符 (~)</li><li>感叹号 (!)</li><li>井号 (#)</li><li>美元符号 ($)</li><li>百分号 (%)</li><li>扬抑符 (^)</li><li>与号 (&)</li><li>星号 (*)</li><li>圆括号 (( ))</li><li>加号 (+)</li><li>等号 (=)</li><li>方括号 ([ ])</li><li>大括号 ({ })</li><li>反斜杠 (\)</li><li>斜杠符号 (/)</li><li>竖线 (|)</li><li>分号 (;)</li><li>冒号 (:)</li><li>引号 (")</li><li>尖括号 (< >)</li><li>问号 (?)</li><li>逗号 (,)</li></ul>但是,存在下列例外情况:<ul><li>允许在用户名中的任何位置使用句点 (.) 或连字符 (-),但名称的开头或结尾除外。</li><li>允许在用户名中的任何位置使用下划线 (_)。 这包括名称的开头或结尾。</li></ul> |
| invitedUserMessageInfo | invitedUserMessageInfo | 要发送至邀请用户的邮件的其他配置,其中包括自定义邮件文本、语言和抄送收件人列表。 |
| sendInvitationMessage | Boolean | 指示电子邮件是否应发送至邀请的用户。 默认值为 false。 |
| inviteRedirectUrl | String | 用户在兑现邀请后会被重定向至该 URL。必填。 |
| inviteRedeemUrl | String | 用户用于兑现邀请的 URL。只读。 |
| invitedUserType | String | 被邀请的用户的 userType。 默认情况下,此操作为 Guest。 如果您是公司管理员, Member 邀请作为管理员。 |
| 状态 | String | 邀请的状态。 可能的值为: PendingAcceptance、 Completed、 InProgress和 Error。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| invitedUser | 用户 | 创建为邀请创建进程组成部分的用户。只读 |
JSON 表示形式
下面是资源的 JSON 表示形式。
{
"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"
}
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 Sammak)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
