Package com.azure.resourcemanager.authorization.fluent.models

Class MicrosoftGraphOAuth2PermissionGrant

java.lang.Object
com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphEntity
com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphOAuth2PermissionGrant
public final class MicrosoftGraphOAuth2PermissionGrant extends MicrosoftGraphEntity
oAuth2PermissionGrant.

  • Constructor Details

    • MicrosoftGraphOAuth2PermissionGrant

      public MicrosoftGraphOAuth2PermissionGrant()
      Creates an instance of MicrosoftGraphOAuth2PermissionGrant class.

  • Method Details

    • clientId

      public String clientId()
      Get the clientId property: The id of the client service principal for the application which is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
      Returns:
      the clientId value.

    • withClientId

      public MicrosoftGraphOAuth2PermissionGrant withClientId(String clientId)
      Set the clientId property: The id of the client service principal for the application which is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
      Parameters:
      clientId - the clientId value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • consentType

      public String consentType()
      Get the consentType property: Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).
      Returns:
      the consentType value.

    • withConsentType

      public MicrosoftGraphOAuth2PermissionGrant withConsentType(String consentType)
      Set the consentType property: Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).
      Parameters:
      consentType - the consentType value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • principalId

      public String principalId()
      Get the principalId property: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal.
      Returns:
      the principalId value.

    • withPrincipalId

      public MicrosoftGraphOAuth2PermissionGrant withPrincipalId(String principalId)
      Set the principalId property: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal.
      Parameters:
      principalId - the principalId value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • resourceId

      public String resourceId()
      Get the resourceId property: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user.
      Returns:
      the resourceId value.

    • withResourceId

      public MicrosoftGraphOAuth2PermissionGrant withResourceId(String resourceId)
      Set the resourceId property: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user.
      Parameters:
      resourceId - the resourceId value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • scope

      public String scope()
      Get the scope property: A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
      Returns:
      the scope value.

    • withScope

      public MicrosoftGraphOAuth2PermissionGrant withScope(String scope)
      Set the scope property: A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
      Parameters:
      scope - the scope value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • additionalProperties

      public Map<String,Object> additionalProperties()
      Get the additionalProperties property: oAuth2PermissionGrant.
      Overrides:
      additionalProperties in class MicrosoftGraphEntity
      Returns:
      the additionalProperties value.

    • withAdditionalProperties

      public MicrosoftGraphOAuth2PermissionGrant withAdditionalProperties(Map<String,Object> additionalProperties)
      Set the additionalProperties property: oAuth2PermissionGrant.
      Overrides:
      withAdditionalProperties in class MicrosoftGraphEntity
      Parameters:
      additionalProperties - the additionalProperties value to set.
      Returns:
      the MicrosoftGraphOAuth2PermissionGrant object itself.

    • withId

      public MicrosoftGraphOAuth2PermissionGrant withId(String id)
      Set the id property: Read-only.
      Overrides:
      withId in class MicrosoftGraphEntity
      Parameters:
      id - the id value to set.
      Returns:
      the MicrosoftGraphEntity object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class MicrosoftGraphEntity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.