directoryRole リソース型directoryRole resource type

Azure AD ディレクトリ ロールを表します。Represents an Azure AD directory role. Azure AD ディレクトリ ロールは、管理者ロールと呼ばれることもあります。Azure AD directory roles are also known as administrator roles. ディレクトリ (管理者) ロールの詳細については、「Azure Active Directory での管理者ロールの割り当て」を参照してください。For more information about directory (administrator) roles, see Assigning administrator roles in Azure AD. Microsoft Graph では、ユーザーにディレクトリ ロールを割り当てることで、ターゲット ロールのアクセス許可をユーザーに付与できます。With the Microsoft Graph, you can assign users to directory roles to grant them the permissions of the target role. ディレクトリ ロールを読み取る場合や、そのメンバーを更新する場合は、まず、そのディレクトリ ロールをテナントでアクティブにする必要があります。To read a directory role or update its members, it must first be activated in the tenant. 既定では、会社の管理者 (Company Administrators) ディレクトリ ロールのみがアクティブ化されています。Only the Company Administrators directory role is activated by default. その他の使用可能なディレクトリ ロールをアクティブ化するには、directoryRoleTemplate の ID を使用して POST 要求を送信します。この ID は、ディレクトリ ロールに基づきます。To activate other available directory roles you send a POST request with the ID of the directoryRoleTemplate on which the directory role is based. ディレクトリ ロール テンプレートを一覧表示し、他の使用可能なすべてのディレクトリ ロールを取得します。List directory role templates to get all the other available directory roles. directoryObject から継承します。Inherits from directoryObject.

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

  • デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
Get directoryRoleGet directoryRole directoryRoledirectoryRole directoryRole オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of directoryRole object.
directoryRoles を一覧表示するList directoryRoles directoryRole コレクションdirectoryRole collection テナントでアクティブになっているディレクトリ ロールを一覧表示します。List the directory roles that are activated in the tenant.
メンバーを追加するAdd member directoryObjectdirectoryObject members ナビゲーション プロパティを送信することで、ユーザーをディレクトリ ロールに追加します。Add a user to the directory role by posting to the members navigation property.
List membersList members directoryObject コレクションdirectoryObject collection members ナビゲーション プロパティから、ディレクトリ ロールのメンバーであるユーザーを取得します。Get the users that are members of the directory role from the members navigation property.
メンバーを削除するRemove a member directoryObjectdirectoryObject ディレクトリ ロールからユーザーを削除します。Remove a user from the directory role.
Activate directoryRoleActivate directoryRole directoryRoledirectoryRole ディレクトリ ロールをアクティブにします。Activate a directory role.
デルタdelta directoryRole コレクションdirectoryRole collection ディレクトリ ルールの増分の変更を取得します。Get incremental changes for directory roles.

プロパティProperties

プロパティProperty Type 説明Description
descriptiondescription StringString ディレクトリ ロールの説明。読み取り専用。The description for the directory role. Read-only.
displayNamedisplayName StringString ディレクトリ ロールの表示名。読み取り専用。The display name for the directory role. Read-only.
idid StringString ディレクトリ ロールの一意識別子。directoryObject から継承されます。キーであり、Null は許容されません。読み取り専用です。The unique identifier for the directory role. Inherited from directoryObject. Key, Not nullable, Read-only.
roleTemplateIdroleTemplateId StringString このロールが基づいている directoryRoleTemplateid。このプロパティは、POST 操作でテナント内のディレクトリ ロールをアクティブ化するときに指定する必要があります。そのディレクトリ ロールがアクティブ化されると、このプロパティは読み取り専用になります。The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
membersmembers directoryObject コレクションdirectoryObject collection このディレクトリ ロールのメンバーであるユーザー。HTTP メソッド: GET、POST、DELETE。読み取り専用。Null 許容型。Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable.

JSON 表記JSON representation

以下は、リソースの JSON 表記ですHere is a JSON representation of the resource

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