OAuth2Permission Class

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.

Inheritance

Model

OAuth2Permission

Constructor

OAuth2Permission(*, admin_consent_description: Optional[str] = None, admin_consent_display_name: Optional[str] = None, id: Optional[str] = None, is_enabled: Optional[bool] = None, type: Optional[str] = None, user_consent_description: Optional[str] = None, user_consent_display_name: Optional[str] = None, value: Optional[str] = None, **kwargs)

Parameters

admin_consent_description

str

Required

Permission help text that appears in the admin consent and app assignment experiences.

admin_consent_display_name

str

Required

Display name for the permission that appears in the admin consent and app assignment experiences.

id

str

Required

Unique scope permission identifier inside the oauth2Permissions collection.

is_enabled

bool

Required

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

str

Required

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".

user_consent_description

str

Required

Permission help text that appears in the end user consent experience.

user_consent_display_name

str

Required

Display name for the permission that appears in the end user consent experience.

value

str

Required

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