Package com.microsoft.graph.models

Class AppRole

java.lang.Object
com.microsoft.graph.models.AppRole
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class AppRole extends Object implements com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.store.BackedModel, com.microsoft.kiota.serialization.Parsable

  • Field Details

    • backingStore

      @Nonnull protected com.microsoft.kiota.store.BackingStore backingStore
      Stores model information.

  • Constructor Details

    • AppRole

      public AppRole()
      Instantiates a new AppRole and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static AppRole createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a AppRole

    • getAdditionalData

      @Nonnull public Map<String,Object> getAdditionalData()
      Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
      Specified by:
      getAdditionalData in interface com.microsoft.kiota.serialization.AdditionalDataHolder
      Returns:
      a Map<String,Object>

    • getAllowedMemberTypes

      @Nullable public List<String> getAllowedMemberTypes()
      Gets the allowedMemberTypes property value. Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.
      Returns:
      a List<String>

    • getBackingStore

      @Nonnull public com.microsoft.kiota.store.BackingStore getBackingStore()
      Gets the backingStore property value. Stores model information.
      Specified by:
      getBackingStore in interface com.microsoft.kiota.store.BackedModel
      Returns:
      a BackingStore

    • getDescription

      @Nullable public String getDescription()
      Gets the description property value. The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.
      Returns:
      a String

    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. Display name for the permission that appears in the app role assignment and consent experiences.
      Returns:
      a String

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getId

      @Nullable public UUID getId()
      Gets the id property value. Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided.
      Returns:
      a UUID

    • getIsEnabled

      @Nullable public Boolean getIsEnabled()
      Gets the isEnabled property value. When creating or updating an app role, 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:
      a Boolean

    • getOdataType

      @Nullable public String getOdataType()
      Gets the @odata.type property value. The OdataType property
      Returns:
      a String

    • getOrigin

      @Nullable public String getOrigin()
      Gets the origin property value. Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.
      Returns:
      a String

    • getValue

      @Nullable public String getValue()
      Gets the value property value. Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with ..
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAdditionalData

      public void setAdditionalData(@Nullable Map<String,Object> value)
      Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
      Parameters:
      value - Value to set for the AdditionalData property.

    • setAllowedMemberTypes

      public void setAllowedMemberTypes(@Nullable List<String> value)
      Sets the allowedMemberTypes property value. Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.
      Parameters:
      value - Value to set for the allowedMemberTypes property.

    • setBackingStore

      public void setBackingStore(@Nonnull com.microsoft.kiota.store.BackingStore value)
      Sets the backingStore property value. Stores model information.
      Parameters:
      value - Value to set for the backingStore property.

    • setDescription

      public void setDescription(@Nullable String value)
      Sets the description property value. The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.
      Parameters:
      value - Value to set for the description property.

    • setDisplayName

      public void setDisplayName(@Nullable String value)
      Sets the displayName property value. Display name for the permission that appears in the app role assignment and consent experiences.
      Parameters:
      value - Value to set for the displayName property.

    • setId

      public void setId(@Nullable UUID value)
      Sets the id property value. Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided.
      Parameters:
      value - Value to set for the id property.

    • setIsEnabled

      public void setIsEnabled(@Nullable Boolean value)
      Sets the isEnabled property value. When creating or updating an app role, 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:
      value - Value to set for the isEnabled property.

    • setOdataType

      public void setOdataType(@Nullable String value)
      Sets the @odata.type property value. The OdataType property
      Parameters:
      value - Value to set for the @odata.type property.

    • setOrigin

      public void setOrigin(@Nullable String value)
      Sets the origin property value. Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.
      Parameters:
      value - Value to set for the origin property.

    • setValue

      public void setValue(@Nullable String value)
      Sets the value property value. Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with ..
      Parameters:
      value - Value to set for the value property.