externalUserProfile リソースの種類

[アーティクル]
02/14/2024

名前空間: microsoft.graph

重要

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

Microsoft Entra テナント内の外部ユーザーのプロファイルを表します。このプロファイルは、ユーザーが pendingExternalUserProfile を引き換えたときに作成されます。保留中の外部ユーザープロファイルは、 CreatependingExternalUserProfile API を使用して作成できます。

externalProfile から継承します。

メソッド

メソッド	戻り値の型	説明
externalUserProfile を取得する	externalUserProfile	外部ユーザープロファイルのプロパティを取得します。
externalUserProfiles を一覧表示する	externalUserProfile コレクション	すべての外部ユーザープロファイルの一覧を取得します。
externalUserProfile を更新する	なし	外部ユーザープロファイルを更新します。
externalUserProfile を削除する	なし	外部ユーザープロファイルを削除します。

プロパティ

プロパティ	型	説明
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"
}