externalUserProfile リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Entra テナント内の外部ユーザーのプロファイルを表します。 このプロファイルは、ユーザーが pendingExternalUserProfile を引き換えたときに作成されます。 保留中の外部ユーザー プロファイルは、 CreatependingExternalUserProfile API を使用して作成できます。
externalProfile から継承します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Get | externalUserProfile | 外部ユーザー プロファイルのプロパティを取得します。 |
| List | externalUserProfile コレクション | すべての外部ユーザー プロファイルの一覧を取得します。 |
| Update | なし | 外部ユーザー プロファイルを更新します。 |
| Delete | なし | 外部ユーザー プロファイルを削除します。 |
| 削除済みアイテムの一覧表示 | directoryObject コレクション | ディレクトリ オブジェクトのコレクションから最近削除された外部ユーザー プロファイルの一覧を取得します。 |
| 削除済みアイテムの取得 | directoryObject | 最近削除した外部ユーザー プロファイル オブジェクトのプロパティを取得します。 |
| 削除済みアイテムの復元 | directoryObject | 最近削除した外部ユーザー プロファイル オブジェクトを復元します。 |
| アイテムを完全に削除する | なし | 外部ユーザー プロファイルを完全に削除します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| address | physicalOfficeAddress | 外部ユーザー プロファイルの Office アドレス。 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-56789abcdee です。 id プロパティの値は、多くの場合、GUID の形式で排他的ではありません。は不透明な識別子として扱い、GUID に依存しません。 キー。 null 許容ではありません。 読み取り専用です。 |
| isDiscoverable | ブール型 | ディレクトリで外部ユーザー プロファイルを検出できるかどうかを表します。
trueすると、この外部プロファイルが Teams 検索に表示されます。
false場合、この外部プロファイルは Teams 検索に表示されません。
externalProfile から継承されます。 |
| isEnabled | ブール値 | ディレクトリで外部ユーザー プロファイルが有効になっているかどうかを表します。 このプロパティは、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"
}