public final class OAuth2Permission extends Object
Constructor and Description |
---|
OAuth2Permission() |
Modifier and Type | Method and Description |
---|---|
String |
adminConsentDescription()
Get the adminConsentDescription property: Permission help text that appears in the admin consent and app
assignment experiences.
|
String |
adminConsentDisplayName()
Get the adminConsentDisplayName property: Display name for the permission that appears in the admin consent and
app assignment experiences.
|
String |
id()
Get the id property: Unique scope permission identifier inside the oauth2Permissions collection.
|
Boolean |
isEnabled()
Get the isEnabled property: When creating or updating a permission, this property must be set to true (which is
the default).
|
String |
type()
Get the type property: 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.
|
String |
userConsentDescription()
Get the userConsentDescription property: Permission help text that appears in the end user consent experience.
|
String |
userConsentDisplayName()
Get the userConsentDisplayName property: Display name for the permission that appears in the end user consent
experience.
|
void |
validate()
Validates the instance.
|
String |
value()
Get the value property: The value of the scope claim that the resource application should expect in the OAuth 2.0
access token.
|
OAuth2Permission |
withAdminConsentDescription(String adminConsentDescription)
Set the adminConsentDescription property: Permission help text that appears in the admin consent and app
assignment experiences.
|
OAuth2Permission |
withAdminConsentDisplayName(String adminConsentDisplayName)
Set the adminConsentDisplayName property: Display name for the permission that appears in the admin consent and
app assignment experiences.
|
OAuth2Permission |
withId(String id)
Set the id property: Unique scope permission identifier inside the oauth2Permissions collection.
|
OAuth2Permission |
withIsEnabled(Boolean isEnabled)
Set the isEnabled property: When creating or updating a permission, this property must be set to true (which is
the default).
|
OAuth2Permission |
withType(String type)
Set the type property: 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.
|
OAuth2Permission |
withUserConsentDescription(String userConsentDescription)
Set the userConsentDescription property: Permission help text that appears in the end user consent experience.
|
OAuth2Permission |
withUserConsentDisplayName(String userConsentDisplayName)
Set the userConsentDisplayName property: Display name for the permission that appears in the end user consent
experience.
|
OAuth2Permission |
withValue(String value)
Set the value property: The value of the scope claim that the resource application should expect in the OAuth 2.0
access token.
|
public String adminConsentDescription()
public OAuth2Permission withAdminConsentDescription(String adminConsentDescription)
adminConsentDescription
- the adminConsentDescription value to set.public String adminConsentDisplayName()
public OAuth2Permission withAdminConsentDisplayName(String adminConsentDisplayName)
adminConsentDisplayName
- the adminConsentDisplayName value to set.public String id()
public OAuth2Permission withId(String id)
id
- the id value to set.public Boolean isEnabled()
public OAuth2Permission withIsEnabled(Boolean isEnabled)
isEnabled
- the isEnabled value to set.public String type()
public OAuth2Permission withType(String type)
type
- the type value to set.public String userConsentDescription()
public OAuth2Permission withUserConsentDescription(String userConsentDescription)
userConsentDescription
- the userConsentDescription value to set.public String userConsentDisplayName()
public OAuth2Permission withUserConsentDisplayName(String userConsentDisplayName)
userConsentDisplayName
- the userConsentDisplayName value to set.public String value()
public OAuth2Permission withValue(String value)
value
- the value value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2020 Microsoft Corporation. All rights reserved.