Share via


OAuth2Permission Class

Definition

Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.

public class OAuth2Permission
type OAuth2Permission = class
Public Class OAuth2Permission
Inheritance
OAuth2Permission

Constructors

OAuth2Permission()

Initializes a new instance of the OAuth2Permission class.

OAuth2Permission(String, String, String, Nullable<Boolean>, String, String, String, String)

Initializes a new instance of the OAuth2Permission class.

Properties

AdminConsentDescription

Gets or sets permission help text that appears in the admin consent and app assignment experiences.

AdminConsentDisplayName

Gets or sets display name for the permission that appears in the admin consent and app assignment experiences.

Id

Gets or sets unique scope permission identifier inside the oauth2Permissions collection.

IsEnabled

Gets or sets when creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.

Type

Gets or sets specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are "User" or "Admin".

UserConsentDescription

Gets or sets permission help text that appears in the end user consent experience.

UserConsentDisplayName

Gets or sets display name for the permission that appears in the end user consent experience.

Value

Gets or sets the value of the scope claim that the resource application should expect in the OAuth 2.0 access token.

Applies to