oAuth2PermissionGrant リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーションのサービス プリンシパルに付与されている委任されたアクセス許可を表します。
委任されたアクセス許可は、ユーザーがアプリケーションの API へのアクセス要求に同意した結果として作成することも、直接作成することもできます。
委任されたアクセス許可は、"OAuth 2.0 スコープ" または "スコープ" と呼ばれることもあります。
メソッド
メソッド | 戻り値の型 | 説明 |
---|---|---|
List | oAuth2PermissionGrant コレクション | 委任されたアクセス許可許可の一覧を取得します。 |
Create | oAuth2PermissionGrant | 委任されたアクセス許可付与を作成します。 |
Get | oAuth2PermissionGrant | 1 つの委任されたアクセス許可付与を読み取る。 |
Update | なし | oAuth2PermissionGrant オブジェクトを更新します。 |
Delete | なし | 委任されたアクセス許可の付与を削除します。 |
Get delta | oAuth2PermissionGrant コレクション | リソース コレクション全体の完全な読み取りを実行せずに、新しく作成、更新、または削除された oauth2permissiongrant オブジェクトを取得します。 |
プロパティ
プロパティ | 型 | 説明 |
---|---|---|
clientId | String | API にアクセスするときにサインインしているユーザーの代わりに動作する権限を持つアプリケーションのクライアント サービス プリンシパルのオブジェクト ID (appIdではありません)。 必須です。
$filter (eq のみ) をサポートします。 |
consentType | String | クライアント アプリケーションに対して、すべてのユーザーを偽装するか、特定のユーザーのみを偽装するかを示します。
AllPrincipals は、 すべてのユーザーを偽装するための承認を示します。
プリンシパル は、特定のユーザーを偽装するための承認を示します。 すべてのユーザーに代わって同意を付与できるのは、管理者です。 一部の委任されたアクセス許可については、管理者以外のユーザーが自分の代わりに同意することを承認される場合があります。 必須です。
$filter (eq のみ) をサポートします。 |
expiryTime | DateTimeOffset | 現在、終了時刻の値は無視されますが、 oAuth2PermissionGrant の作成時には値が必要です。 必須。 |
id | String | oAuth2PermissionGrant の一意識別子。 読み取り専用。 |
principalId | String |
consentTypeがPrincipal の場合、クライアントがリソースへのアクセスを許可されているユーザーの代わりに使用する ID。
consentType が AllPrincipals の場合、この値は null です。
consentType が Principal の場合は必須です。
$filter (eq のみ) をサポートします。 |
resourceId | String | アクセスが承認されるリソース サービス プリンシパルの ID。 これにより、クライアントがサインインしているユーザーの代わりに呼び出そうとする権限を持つ API が識別されます。
$filter (eq のみ) をサポートします。 |
スコープ | String | リソース アプリケーション (API) のアクセス トークンに含める必要がある委任されたアクセス許可の要求値のスペース区切りのリスト。 たとえば、「 openid User.Read GroupMember.Read.All 」のように入力します。 各要求値は、リソース サービス プリンシパルの publishedPermissionScopes プロパティに記載されている、API によって定義された委任されたアクセス許可の 1 つの値フィールドと一致する必要があります。 長さは 3850 文字以内にする必要があります。 |
startTime | DateTimeOffset | 現在、開始時刻の値は無視されますが、 oAuth2PermissionGrant の作成時には値が必要です。 必須です。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"clientId": "String",
"consentType": "String",
"expiryTime": "String (timestamp)",
"id": "String (identifier)",
"principalId": "String",
"resourceId": "String",
"scope": "String",
"startTime": "String (timestamp)"
}