AppRole (Azure SDK for Java Reference Documentation)
Constructor Summary
Constructors
Constructor and Description AppRole()
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description List<String>
allowedMemberTypes()
Get the allowedMemberTypes property: Specifies whether this app role definition can be assigned to users and groups by setting to 'User', or to other applications (that are accessing this application in daemon service scenarios) by setting to 'Application', or to both.
String
description()
Get the description property: Permission help text that appears in the admin app assignment and consent experiences.
String
displayName()
Get the displayName property: Display name for the permission that appears in the admin consent and app assignment experiences.
String
id()
Get the id property: Unique role identifier inside the appRoles collection.
Boolean
isEnabled()
Get the isEnabled property: When creating or updating a role definition, this must be set to true (which is the default).
void
validate()
Validates the instance.
String
value()
Get the value property: Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
AppRole
withAllowedMemberTypes(List<String> allowedMemberTypes)
Set the allowedMemberTypes property: Specifies whether this app role definition can be assigned to users and groups by setting to 'User', or to other applications (that are accessing this application in daemon service scenarios) by setting to 'Application', or to both.
AppRole
withDescription(String description)
Set the description property: Permission help text that appears in the admin app assignment and consent experiences.
AppRole
withDisplayName(String displayName)
Set the displayName property: Display name for the permission that appears in the admin consent and app assignment experiences.
AppRole
withId(String id)
Set the id property: Unique role identifier inside the appRoles collection.
AppRole
withIsEnabled(Boolean isEnabled)
Set the isEnabled property: When creating or updating a role definition, this must be set to true (which is the default).
AppRole
withValue(String value)
Set the value property: Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
Constructor Detail
AppRole
public AppRole()
Method Detail
withId
public AppRole withId(String id)
Set the id property: Unique role identifier inside the appRoles collection.
Parameters:id
- the id value to set. Returns: the AppRole object itself.
allowedMemberTypes
public List<String> allowedMemberTypes()
Get the allowedMemberTypes property: Specifies whether this app role definition can be assigned to users and groups by setting to 'User', or to other applications (that are accessing this application in daemon service scenarios) by setting to 'Application', or to both.
Returns: the allowedMemberTypes value.
withAllowedMemberTypes
public AppRole withAllowedMemberTypes(List<String> allowedMemberTypes)
Set the allowedMemberTypes property: Specifies whether this app role definition can be assigned to users and groups by setting to 'User', or to other applications (that are accessing this application in daemon service scenarios) by setting to 'Application', or to both.
Parameters:allowedMemberTypes
- the allowedMemberTypes value to set. Returns: the AppRole object itself.
description
public String description()
Get the description property: Permission help text that appears in the admin app assignment and consent experiences.
Returns: the description value.
withDescription
public AppRole withDescription(String description)
Set the description property: Permission help text that appears in the admin app assignment and consent experiences.
Parameters:description
- the description value to set. Returns: the AppRole object itself.
displayName
public String displayName()
Get the displayName property: Display name for the permission that appears in the admin consent and app assignment experiences.
Returns: the displayName value.
withDisplayName
public AppRole withDisplayName(String displayName)
Set the displayName property: Display name for the permission that appears in the admin consent and app assignment experiences.
Parameters:displayName
- the displayName value to set. Returns: the AppRole object itself.
isEnabled
public Boolean isEnabled()
Get the isEnabled property: When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
Returns: the isEnabled value.
withIsEnabled
public AppRole withIsEnabled(Boolean isEnabled)
Set the isEnabled property: When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
Parameters:isEnabled
- the isEnabled value to set. Returns: the AppRole object itself.
withValue
public AppRole withValue(String value)
Set the value property: Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
Parameters:value
- the value value to set. Returns: the AppRole object itself.
validate
public void validate()
Validates the instance.
Throws:IllegalArgumentException
- thrown if the instance is not valid.
Copyright © 2020 Microsoft Corporation. All rights reserved.
ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnploopGrrnCt2a6pnmWimsCwwdGcnKaZnpa0pr6MmqytoJ%2Bntrut06Kmp2diY35vfI6cpqZnka%2FCs7GOq5ysp6WnsKa5wKeYoJ2iZK62wMeoqaKykam2sLqOpqadnZyofIK8z4umpZ1encGuuA%3D%3D