MicrosoftGraphPermissionScope Class

Package:

com.azure.resourcemanager.authorization.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-authorization:2.40.0

• java.lang.Object
• • com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphPermissionScope

public final class MicrosoftGraphPermissionScope

permissionScope.

Constructor Summary

Constructor	Description
MicrosoftGraphPermissionScope()	Creates an instance of MicrosoftGraphPermissionScope class.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	additionalProperties() Get the additionalProperties property: permissionScope.
String	adminConsentDescription() Get the adminConsentDescription property: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
String	adminConsentDisplayName() Get the adminConsentDisplayName property: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
UUID	id() Get the id property: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
Boolean	isEnabled() Get the isEnabled property: When creating or updating a permission, this property must be set to true (which is the default).
String	origin() Get the origin property: The origin property.
String	type() Get the type property: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.
String	userConsentDescription() Get the userConsentDescription property: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
String	userConsentDisplayName() Get the userConsentDisplayName property: A title for the permission, intended to be read by a user granting the permission on their own behalf.
void	validate() Validates the instance.
String	value() Get the value property: Specifies the value to include in the scp (scope) claim in access tokens.
MicrosoftGraphPermissionScope	withAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: permissionScope.
MicrosoftGraphPermissionScope	withAdminConsentDescription(String adminConsentDescription) Set the adminConsentDescription property: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
MicrosoftGraphPermissionScope	withAdminConsentDisplayName(String adminConsentDisplayName) Set the adminConsentDisplayName property: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
MicrosoftGraphPermissionScope	withId(UUID id) Set the id property: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
MicrosoftGraphPermissionScope	withIsEnabled(Boolean isEnabled) Set the isEnabled property: When creating or updating a permission, this property must be set to true (which is the default).
MicrosoftGraphPermissionScope	withOrigin(String origin) Set the origin property: The origin property.
MicrosoftGraphPermissionScope	withType(String type) Set the type property: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions.
MicrosoftGraphPermissionScope	withUserConsentDescription(String userConsentDescription) Set the userConsentDescription property: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
MicrosoftGraphPermissionScope	withUserConsentDisplayName(String userConsentDisplayName) Set the userConsentDisplayName property: A title for the permission, intended to be read by a user granting the permission on their own behalf.
MicrosoftGraphPermissionScope	withValue(String value) Set the value property: Specifies the value to include in the scp (scope) claim in access tokens.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MicrosoftGraphPermissionScope

public MicrosoftGraphPermissionScope()

Creates an instance of MicrosoftGraphPermissionScope class.

Method Details

additionalProperties

public Map additionalProperties()

Get the additionalProperties property: permissionScope.

Returns:

the additionalProperties value.

adminConsentDescription

public String adminConsentDescription()

Get the adminConsentDescription property: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences.

Returns:

the adminConsentDescription value.

adminConsentDisplayName

public String adminConsentDisplayName()

Get the adminConsentDisplayName property: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.

Returns:

the adminConsentDisplayName value.

id

public UUID id()

Get the id property: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.

Returns:

the id value.

isEnabled

public Boolean isEnabled()

Get the isEnabled property: 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.

Returns:

the isEnabled value.

origin

public String origin()

Get the origin property: The origin property.

Returns:

the origin value.

type

public String type()

Get the type property: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.).

Returns:

the type value.

userConsentDescription

public String userConsentDescription()

Get the userConsentDescription property: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.

Returns:

the userConsentDescription value.

userConsentDisplayName

public String userConsentDisplayName()

Get the userConsentDisplayName property: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.

Returns:

the userConsentDisplayName value.

validate

public void validate()

Validates the instance.

value

public String value()

Get the value property: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed.

Returns:

the value value.

withAdditionalProperties

public MicrosoftGraphPermissionScope withAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: permissionScope.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withAdminConsentDescription

public MicrosoftGraphPermissionScope withAdminConsentDescription(String adminConsentDescription)

Set the adminConsentDescription property: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences.

Parameters:

adminConsentDescription - the adminConsentDescription value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withAdminConsentDisplayName

public MicrosoftGraphPermissionScope withAdminConsentDisplayName(String adminConsentDisplayName)

Set the adminConsentDisplayName property: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.

Parameters:

adminConsentDisplayName - the adminConsentDisplayName value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withId

public MicrosoftGraphPermissionScope withId(UUID id)

Set the id property: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.

Parameters:

id - the id value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withIsEnabled

public MicrosoftGraphPermissionScope withIsEnabled(Boolean isEnabled)

Set the isEnabled property: 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.

Parameters:

isEnabled - the isEnabled value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withOrigin

public MicrosoftGraphPermissionScope withOrigin(String origin)

Set the origin property: The origin property.

Parameters:

origin - the origin value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withType

public MicrosoftGraphPermissionScope withType(String type)

Set the type property: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.).

Parameters:

type - the type value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withUserConsentDescription

public MicrosoftGraphPermissionScope withUserConsentDescription(String userConsentDescription)

Set the userConsentDescription property: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.

Parameters:

userConsentDescription - the userConsentDescription value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withUserConsentDisplayName

public MicrosoftGraphPermissionScope withUserConsentDisplayName(String userConsentDisplayName)

Set the userConsentDisplayName property: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.

Parameters:

userConsentDisplayName - the userConsentDisplayName value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.

withValue

public MicrosoftGraphPermissionScope withValue(String value)

Set the value property: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed.

Parameters:

value - the value value to set.

Returns:

the MicrosoftGraphPermissionScope object itself.