directoryRole リソース型

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

メソッド

メソッド 戻り値の型 説明
Get directoryRole directoryRole directoryRole オブジェクトのプロパティとリレーションシップを読み取ります。
Create member directoryObject members ナビゲーション プロパティを送信することで、ユーザーをディレクトリ ロールに追加します。
List members directoryObject コレクション members ナビゲーション プロパティから、ディレクトリ ロールのメンバーであるユーザーを取得します。
Activate directoryRole directoryRole ディレクトリ ロールをアクティブ化します。

プロパティ

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

リレーションシップ

リレーションシップ 説明
members directoryObject コレクション このディレクトリ ロールのメンバーであるユーザー。HTTP メソッド: GET、POST、DELETE。読み取り専用。Null 許容型。

JSON 表記

以下は、リソースの JSON 表記です

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