directoryRole リソース型

名前空間: microsoft.graph

重要

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

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

既定では、ディレクトリ ロールのスコープはテナント全体に設定されます。 ただし、ディレクトリ ロール (現在はユーザー アカウント 管理者 と ヘルプ デスク管理者のみ) も管理単位に スコープを設定できます。

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

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

メソッド

メソッド	戻り値の型	説明
Get directoryRole	directoryRole	directoryRole オブジェクトのプロパティとリレーションシップを読み取ります。
directoryRoles を一覧表示する	directoryRole コレクション	テナントでアクティブになっているディレクトリ ロールを一覧表示します。
メンバーを追加する	directoryObject	members ナビゲーション プロパティを送信することで、ユーザーをディレクトリ ロールに追加します。
List members	directoryObject コレクション	members ナビゲーション プロパティから、ディレクトリ ロールのメンバーであるユーザーを取得します。
メンバーを削除する	directoryObject	ディレクトリ ロールからユーザーを削除します。
Activate directoryRole	directoryRole	ディレクトリ ロールをアクティブにします。
List scopeMembers	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"
}