pendingExternalUserProfile を作成する

[アーティクル]
03/05/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい pendingExternalUserProfile オブジェクトを作成します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	PendingExternalUserProfile.ReadWrite.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	PendingExternalUserProfile.ReadWrite.All	注意事項なし。

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされている Microsoft Entra ロールまたはサポートされているロールのアクセス許可を持つカスタムロールを割り当てる必要があります。 Teams サービス管理者 は、この操作でサポートされる最小限の特権ロールです。

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-56789abcdee です。 ID プロパティの値は多くの場合、GUID の形式になりますが、これに限定されません。それを不透明な識別子として扱い、GUID であることに依存しないでください。キー。 null 許容ではありません。読み取り専用です。
isDiscoverable	ブール型	保留中の外部ユーザープロファイルがディレクトリ内で検出可能かどうかを表します。
isEnabled	ブール値	保留中の外部ユーザープロファイルがディレクトリで有効になっているかどうかを表します。
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);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta directory pending-external-user-profiles create --body '{\
    "phoneNumber": "+15555555555",\
    "displayName": "Bob Henry"\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// 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)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// 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);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const pendingExternalUserProfile = {
    phoneNumber: '+15555555555',
    displayName: 'Bob Henry'
};

await client.api('/directory/pendingExternalUserProfiles')
	.version('beta')
	.post(pendingExternalUserProfile);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?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();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	phoneNumber = "+15555555555"
	displayName = "Bob Henry"
}

New-MgBetaDirectoryPendingExternalUserProfile -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.pending_external_user_profile import PendingExternalUserProfile

graph_client = GraphServiceClient(credentials, scopes)

request_body = PendingExternalUserProfile(
	phone_number = "+15555555555",
	display_name = "Bob Henry",
)

result = await graph_client.directory.pending_external_user_profiles.post(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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
}

次の方法で共有

pendingExternalUserProfile を作成する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース