appRole リソースの種類

名前空間: microsoft.graph

クライアント アプリケーションで要求 (および付与) できるアプリケーション ロール、または指定した役割のユーザーまたはグループにアプリケーションを割り当てるのに使用できるアプリケーション の役割を表します。

アプリケーションのアプリ の役割を追加、更新、または削除するには 、アプリ またはサービスのアプリケーションを更新します。 アプリケーション エンティティ上のアプリの役割は、アプリケーションが使用されているすべてのテナントで使用できます。 テナントでのみ適用可能なアプリの役割 (たとえば、マルチテナント アプリケーションのインスタンスのカスタム ロールを表すアプリ の役割) を定義するには、アプリのサービス プリンシパルを 更新し、appRoles コレクションにアプリの役割を追加または更新することもできます。

appRoleAssignments を使用すると、アプリの役割をユーザー、グループ、または他のアプリケーションのサービス プリンシパルに割り当てることができます。

プロパティ

プロパティ 説明
allowedMemberTypes String collection このアプリの役割 ["User"]を (に設定して) ユーザーとグループに割り当て可能かどうかを指定します (に設定して)、他のアプリケーションに ( ["Application"]に設定して)、または両方に設定します ["User", "Application"]。 他のアプリケーションのサービス プリンシパルへの割り当てをサポートするアプリの役割は、アプリケーションのアクセス許可とも呼ばれる。 "Application" 値は、アプリケーション エンティティで定義されたアプリ ロール でのみ サポートされます。
説明 String アプリロールの説明。 これは、アプリの役割が割り当てられているときに表示され、アプリの役割がアプリケーションのアクセス許可として機能する場合は、同意エクスペリエンス中に表示されます。
displayName String アプリの役割の割り当てと同意エクスペリエンスに表示されるアクセス許可の名前を表示します。
id Guid appRoles コレクション内の一意の役割 識別子。 新しいアプリ ロールを作成する場合は、新しい GUID 識別子を指定する必要があります。
isEnabled ブール値 アプリロールを作成または更新する場合は、これを true (既定値) に設定する必要があります。 役割を削除するには、最初に false に設定する必要 があります。 その時点で、後続の呼び出しで、この役割が削除される可能性があります。
origin String アプリ の役割がアプリケーション オブジェクトまたは servicePrincipal エンティティで定義される場合に指定します。 POST または PATCH 要求には含めません。 読み取り専用です。
value 文字列型 (String) 割り当てられたユーザーまたはサービス プリンシパル roles を認証する ID トークンとアクセス トークンにクレームに含める値を指定します。 長さは 120 文字以内です。 使用できる文字は、: ` ] @ ^ ' & ( % $ # ! > ? [ ; ~< } + * , - . ) / _ | = { : +範囲の文字と同様に0-9、および です。 A-Z a-z その他の文字 (スペース文字を含む) は使用できない。 で始めない場合があります .

JSON 表記

リソースの JSON 表記を次に示します。

{
  "allowedMemberTypes": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "Guid",
  "isEnabled": true,
  "origin": "String",
  "value": "String"
}