directoryRole リソース型

[アーティクル]
03/26/2023

名前空間: microsoft.graph

Microsoft Entra ディレクトリロールを表します。 Microsoft Entraディレクトリロールは、管理者ロールとも呼ばれます。ディレクトリ (管理者) ロールの詳細については、「Microsoft Entra管理者ロールの割り当て」を参照してください。 Microsoft Graph では、ユーザーにディレクトリロールを割り当てることで、ターゲットロールのアクセス許可をユーザーに付与できます。ディレクトリロールを読み取る場合や、そのメンバーを更新する場合は、まず、そのディレクトリロールをテナントでアクティブにする必要があります。既定では、会社の管理者 (Company Administrators) ディレクトリロールのみがアクティブ化されています。その他の使用可能なディレクトリロールをアクティブ化するには、directoryRoleTemplate の ID を使用して POST 要求を送信します。この ID は、ディレクトリロールに基づきます。ディレクトリロールテンプレートを一覧表示し、他の使用可能なすべてのディレクトリロールを取得します。 directoryObject から継承します。

このリソースは以下をサポートしています。

デルタ関数を提供することにより、デルタクエリを使用して、増分の追加、削除、更新を追跡します。

メソッド

メソッド	戻り値の型	説明
Get directoryRole	directoryRole	directoryRole オブジェクトのプロパティとリレーションシップを読み取ります。
directoryRoles を一覧表示する	directoryRole コレクション	テナントでアクティブになっているディレクトリロールを一覧表示します。
メンバーを追加する	directoryObject	members ナビゲーションプロパティを送信することで、ユーザーをディレクトリロールに追加します。
List members	directoryObject コレクション	members ナビゲーションプロパティから、ディレクトリロールのメンバーであるユーザーを取得します。
メンバーを削除する	directoryObject	ディレクトリロールからユーザーを削除します。
Activate directoryRole	directoryRole	ディレクトリロールをアクティブにします。
リスト scopedMembers	scopedRoleMembership コレクション	scopedRoleMembership リソースコレクションを通して、管理単位を範囲とした、このディレクトリロールのメンバーを表示します。
デルタ	directoryRole コレクション	ディレクトリルールの増分の変更を取得します。

プロパティ

プロパティ	型	説明
description	String	ディレクトリロールの説明。読み取り専用。 `$filter` (`eq`), `$search`, `$select` をサポートしています。
displayName	文字列	ディレクトリロールの表示名。読み取り専用。 `$filter` (`eq`), `$search`, `$select` をサポートしています。
id	文字列	ディレクトリロールの一意識別子。directoryObject から継承されます。キーであり、Null は許容されません。読み取り専用です。 `$filter` (`eq`), `$select` をサポートしています。
roleTemplateId	String	このロールが基づいている directoryRoleTemplate の id。このプロパティは、POST 操作でテナント内のディレクトリロールをアクティブ化するときに指定する必要があります。そのディレクトリロールがアクティブ化されると、このプロパティは読み取り専用になります。 `$filter` (`eq`), `$select` をサポートしています。

リレーションシップ

リレーションシップ	型	説明
members	directoryObject コレクション	このディレクトリロールのメンバーであるユーザー。 HTTP メソッド: GET、POST、DELETE。読み取り専用です。 Null 許容型。 `$expand` をサポートします。
scopedMembers	scopedRoleMembership コレクション	管理単位を範囲とした、このディレクトリロールのメンバー。読み取り専用。 Null 許容型。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "roleTemplateId": "string"
}