externalUserProfile 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示 Microsoft Entra 租户中外部用户的配置文件。 当用户兑换其 pendingExternalUserProfile 时，将创建此配置文件。 可以通过 创建 pendingExternalUserProfile API 创建挂起的外部用户配置文件。
继承自 externalProfile。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get | externalUserProfile | 获取外部用户配置文件的属性。 |
| List | externalUserProfile 集合 | 获取所有外部用户配置文件的列表。 |
| 更新 | 无 | 更新外部用户配置文件。 |
| 删除 | None | 删除外部用户配置文件。 |
| List deleted items | directoryObject collection | 从目录对象集合中检索最近删除的外部用户配置文件的列表。 |
| Get deleted item | directoryObject | 检索最近删除的外部用户配置文件对象的属性。 |
| Restore deleted item | directoryObject | 还原最近删除的外部用户配置文件对象。 |
| 永久删除项目 | None | 永久删除外部用户配置文件。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| address | physicalOfficeAddress | 外部用户配置文件的办公室地址。 继承自 externalProfile。 |
| createdBy | String | 创建外部用户配置文件的用户的对象 ID。 继承自 externalProfile。 只读。 不可为 null。 |
| createdDateTime | DateTimeOffset | 创建此外部用户的日期和时间。 继承自 externalProfile。 不可为 null。 只读。 |
| CompanyName | String | 外部用户配置文件的公司名称。 继承自 externalProfile。 支持 $filter（eq、startswith）。 |
| deletedDateTime | DateTimeOffset | 删除此外部用户配置文件的日期和时间。 始终 null 不删除对象时。 继承自 externalProfile。 |
| department | String | 外部用户配置文件的部门。 继承自 externalProfile。 |
| displayName | String | 外部用户配置文件的显示名称。 继承自 externalProfile。 |
| id | String | 外部用户配置文件的唯一标识符。 例如，12345678-9abc-def0-1234-56789abcde。 id 属性的值通常但不以 GUID 的形式独占;将其视为不透明的标识符，不要依赖它是 GUID。 键。 不可为 null。 只读。 |
| isDiscoverable | 布尔值 | 表示是否可以在目录中发现外部用户配置文件。 当 为 时 true，此外部配置文件将显示在 Teams 搜索中。 当 为 时 false，此外部配置文件不会显示在 Teams 搜索中。 继承自 externalProfile。 |
| isEnabled | Boolean | 表示是否在目录中启用外部用户配置文件。 此属性与 User 对象上的 属性对等accountEnabled。 |
| jobTitle | String | 外部用户配置文件的职务。 继承自 externalProfile。 |
| phoneNumber | String | 外部用户配置文件的电话号码。 必须采用 E164 格式。 继承自 externalProfile。 |
| supervisorId | String | 外部用户配置文件的主管的对象 ID。 继承自 externalProfile。 支持 $filter（eq、startswith）。 |
关系
无。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@odata.type": "#microsoft.graph.externalUserProfile",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"createdDateTime": "String (timestamp)",
"createdBy": "String",
"companyName": "String",
"displayName": "String",
"jobTitle": "String",
"isDiscoverable": "Boolean",
"isEnabled": "Boolean",
"department": "String",
"phoneNumber": "String",
"address": {
"@odata.type": "microsoft.graph.physicalOfficeAddress"
},
"supervisorId": "String"
}