名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーション ロールを表します。 クライアント アプリケーションは、アプリケーション ロールを要求できます。 アプリケーション・ロールを使用して、指定したロールのユーザーまたはグループにアプリケーションを割り当てることもできます。
アプリケーションのアプリ ロールを追加、更新、または削除するには、アプリまたはサービスの アプリケーションを更新 します。 アプリケーション エンティティのアプリ ロールは、アプリケーションが使用されているすべてのテナントで使用できます。 テナントにのみ適用できるアプリ ロール (たとえば、マルチテナント アプリケーションのインスタンスでカスタム ロールを表すアプリ ロール) を定義するには、アプリの サービス プリンシパルを更新 して、アプリ ロールを appRoles コレクションに追加または更新することもできます。
appRoleAssignments を使用すると、アプリ ロールをユーザー、グループ、またはその他のアプリケーションのサービス プリンシパルに割り当てることができます。
実際の例については 、「例 2: アプリケーションの appRoles を更新する」 を参照してください。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| allowedMemberTypes | String collection | このアプリの役割を、ユーザーとグループに割り当てることができるかどうか ( ["User"] に設定した場合)、他のアプリケーションのロールを ( ["Application"] に設定した場合)、またはその両方 ( ["User", "Application"] に設定した場合) に割り当てることができるかどうかを指定します。 他のアプリケーションのサービス プリンシパルへの割り当てをサポートするアプリ ロールは、 アプリケーション アクセス許可とも呼ばれます。 "Application" 値は、 アプリケーション エンティティで定義されたアプリ ロールでのみサポートされます。 |
| 説明 | String | アプリ ロールの説明。 これは、アプリ ロールが割り当てられているとき、またアプリ ロールがアプリケーションのアクセス許可として機能している場合は、同意エクスペリエンス中に表示されます。 |
| displayName | 文字列 | アプリ ロールの割り当てと同意のエクスペリエンスに表示されるアクセス許可の表示名。 |
| id | Guid | appRoles コレクション内の一意のロール識別子。 新しいアプリ ロールを作成するときは、新しい GUID 識別子を指定する必要があります。 |
| isEnabled | ブール値 | アプリ ロールを作成または更新する場合、この値は true である必要があります。 ロールを削除するには、最初にこれを false に設定する必要があります。 その時点で、後続の呼び出しで、この役割が削除される可能性があります。 既定値は true です。 |
| origin | 文字列 | アプリ ロールが アプリケーション オブジェクトまたは servicePrincipal エンティティのどちらで定義されているかを指定します。 POST または PATCH 要求に含めることはできません。 読み取り専用です。 |
| value | 文字列 | 割り当てられたユーザーまたはサービス プリンシパルを認証する ID トークンとアクセス トークンの roles 要求に含める値を指定します。 長さは 120 文字を超えてはなりません。 使用できる文字は :!#$%&'()*+,-./:;<=>?@[]^+_`{|}~ で、範囲内は 0-9、 A-Z、 a-z 文字です。 スペース文字を含むその他の文字は使用できません。
. で始めることはできません。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"allowedMemberTypes": ["String"],
"description": "String",
"displayName": "String",
"id": "Guid",
"isEnabled": true,
"origin": "String",
"value": "String"
}