命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 pendingExternalUserProfile 对象。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
PendingExternalUserProfile.ReadWrite.All |
不可用。 |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
PendingExternalUserProfile.ReadWrite.All |
不可用。 |
HTTP 请求
POST /directory/pendingExternalUserProfiles
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供 pendingExternalUserProfile 的 JSON 表示形式。
| 属性 |
类型 |
说明 |
| address |
physicalOfficeAddress |
挂起的外部用户配置文件的办公室地址。 |
| createdBy |
String |
创建挂起的外部用户配置文件的用户的对象 ID。 只读。 不可为 null。 |
| createdDateTime |
DateTimeOffset |
创建此挂起的外部用户配置文件的日期和时间。 不可为 null。 只读。 |
| CompanyName |
String |
挂起的外部用户配置文件的公司名称。 |
| deletedDateTime |
DateTimeOffset |
删除挂起的外部用户配置文件的日期和时间。 始终 null 不删除对象时。 |
| department |
String |
挂起的外部用户配置文件的部门。 |
| displayName |
String |
挂起的外部用户配置文件的显示名称。
必需。 |
| 时代 |
Int |
挂起的外部用户配置文件的版本号。 随着实体的每次更新而递增。 只读。 不可为 null。 |
| id |
String |
挂起的外部用户配置文件的唯一标识符。 例如,12345678-9abc-def0-1234-56789abcde。
id 属性的值通常(但不总是)用 GUID 表示;将它视为不透明标识符,不要总将它视为 GUID。 键。 不可为 null。 只读。 |
| isDiscoverable |
布尔值 |
表示在目录中是否可以发现挂起的外部用户配置文件。 |
| isEnabled |
Boolean |
表示是否在目录中启用挂起的外部用户配置文件。 |
| jobTitle |
String |
外部用户配置文件的职务。 |
| phoneNumber |
String |
挂起的外部用户配置文件的电话号码。 必须采用 E164 格式。
必需。 |
| supervisorId |
String |
挂起的外部用户配置文件的主管的对象 ID。 |
响应
如果成功,此方法将 201 Created 返回响应代码和 pendingExternalUserProfile 对象。 如果失败,将返回错误 4xx ,其中包含特定详细信息。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
Content-type: application/json
{
"phoneNumber": "+15555555555",
"displayName": "Bob Henry"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new PendingExternalUserProfile
{
PhoneNumber = "+15555555555",
DisplayName = "Bob Henry",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.PendingExternalUserProfiles.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewPendingExternalUserProfile()
phoneNumber := "+15555555555"
requestBody.SetPhoneNumber(&phoneNumber)
displayName := "Bob Henry"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
pendingExternalUserProfiles, err := graphClient.Directory().PendingExternalUserProfiles().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PendingExternalUserProfile pendingExternalUserProfile = new PendingExternalUserProfile();
pendingExternalUserProfile.setPhoneNumber("+15555555555");
pendingExternalUserProfile.setDisplayName("Bob Henry");
PendingExternalUserProfile result = graphClient.directory().pendingExternalUserProfiles().post(pendingExternalUserProfile);
const options = {
authProvider,
};
const client = Client.init(options);
const pendingExternalUserProfile = {
phoneNumber: '+15555555555',
displayName: 'Bob Henry'
};
await client.api('/directory/pendingExternalUserProfiles')
.version('beta')
.post(pendingExternalUserProfile);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\PendingExternalUserProfile;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PendingExternalUserProfile();
$requestBody->setPhoneNumber('+15555555555');
$requestBody->setDisplayName('Bob Henry');
$result = $graphServiceClient->directory()->pendingExternalUserProfiles()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
phoneNumber = "+15555555555"
displayName = "Bob Henry"
}
New-MgBetaDirectoryPendingExternalUserProfile -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.pending_external_user_profile import PendingExternalUserProfile
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PendingExternalUserProfile(
phone_number = "+15555555555",
display_name = "Bob Henry",
)
result = await graph_client.directory.pending_external_user_profiles.post(request_body)
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-type: application/json
{
"id":"1e4ba82a-5f0c-423c-83e1-fc8ad69d8f02",
"isEnabled":true,
"createdDateTime":"2020-11-12T17:53:48Z",
"deletedDateTime":null,
"department":null,
"displayName":"Bob Henry",
"isDiscoverable":true,
"jobTitle":null,
"phoneNumber":"4257034568",
"address": {
"city": null,
"countryOrRegion": null,
"officeLocation": null,
"postalCode": null,
"state": null,
"street": null
},
"epoch":1,
"createdBy":"67670e18-bf37-416c-b5c8-3bfdaad757cc",
"supervisorId":null,
"companyName":null
}