directoryRoleTemplate リソース型directoryRoleTemplate resource type

ディレクトリ ロール テンプレートを表します。ディレクトリ ロール テンプレートでは、ディレクトリ ロール (directoryRole) のプロパティ値を指定します。テナントでアクティブにすることがあるディレクトリの役割ごとに、関連付けられているディレクトリ ロール テンプレート オブジェクトがあります。ディレクトリ ロールを読み取る場合や、そのメンバーを更新する場合は、まず、そのディレクトリ ロールをテナントでアクティブにする必要があります。既定では、会社の管理者 (Company Administrators) ディレクトリ ロールのみがアクティブ化されています。その他の使用可能なディレクトリ ロールをアクティブ化するには、ディレクトリ ロール テンプレートの ID を使用して /directoryRoles エンドポイントに POST 要求を送信します。この ID は、要求の roleTemplateId パラメーターで指定したディレクトリ ロールに基づきます。この要求が正常に完了すると、ディレクトリ ロールの読み取りや、ディレクトリ ロールへのメンバーの追加ができるようになります。:ディレクトリ ロール テンプレートは、ユーザー (Users) ディレクトリ ロールに公開されます。ユーザー ディレクトリ ロールは、暗黙的であり、ディレクトリ クライアントには表示されません。テナント内のすべてのユーザーは、インフラストラクチャによって、このロールに割り当てられます。このロールは、あらかじめアクティブ化されています。このテンプレートは、使用しないでください。Represents a directory role template. A directory role template specifies the property values of a directory role (directoryRole). There is an associated directory role template object for each of the directory roles that may be activated in a tenant. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators directory role is activated by default. To activate other available directory roles you send a POST request to the /directoryRoles endpoint with the ID of the directory role template on which the directory role is based specified in the roleTemplateId parameter of the request. Upon successful completion of this request, you can then start to read and assign members to the directory role. Note: A directory role template is exposed for the Users directory role. The Users directory role is implicit and is not visible to directory clients. Every User in the tenant is assigned to this role by the infrastructure. The role is already activated. Do not use this template.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
Get directoryRoleTemplateGet directoryRoleTemplate directoryRoleTemplatedirectoryRoleTemplate directoryRoleTemplate オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of directoryRoleTemplate object.
List directoryRoleTemplateList directoryRoleTemplate directoryRoleTemplate コレクションdirectoryRoleTemplate collection directoryRoleTemplate オブジェクトのリストを取得しますRetrieve a list of directoryRoleTemplate objects.

プロパティProperties

プロパティProperty Type 説明Description
descriptiondescription StringString ディレクトリ ロールに設定する説明。読み取り専用。The description to set for the directory role. Read-only.
displayNamedisplayName StringString ディレクトリ ロールに設定する表示名。読み取り専用。The display name to set for the directory role. Read-only.
idid 文字列String テンプレートの一意識別子。directoryObject から継承されます。POST 要求の roleTemplateId プロパティにディレクトリ ロール テンプレートの id を指定して、テナントの directoryRole をアクティブ化します。キーであり、Null は許容されません。読み取り専用。The unique identifier for the template. Inherited from directoryObject. You specify the id of the directory role template for the roleTemplateId property in the POST request activate a directoryRole in a tenant. Key, Not nullable. Read-only.

リレーションシップRelationships

なしNone

JSON 表記JSON representation

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

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