Share via

MicrosoftGraphOAuth2PermissionGrant Class

  • Reference
Package:
com.azure.resourcemanager.authorization.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-authorization:2.44.0

public final class MicrosoftGraphOAuth2PermissionGrant
extends MicrosoftGraphEntity

oAuth2PermissionGrant.

Constructor Summary

Constructor Description
MicrosoftGraphOAuth2PermissionGrant()

Creates an instance of MicrosoftGraphOAuth2PermissionGrant class.

Method Summary

Modifier and Type Method and Description
Map<String,Object> additionalProperties()

Get the additionalProperties property: oAuth2PermissionGrant.
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.
String consentType()

Get the consentType property: Indicates if authorization is granted for the client application to impersonate all users or only a specific user.
static MicrosoftGraphOAuth2PermissionGrant fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftGraphOAuth2PermissionGrant from the JsonReader.
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.
String resourceId()

Get the resourceId property: The id of the resource service principal to which access is authorized.
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).
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
MicrosoftGraphOAuth2PermissionGrant withAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: oAuth2PermissionGrant.
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.
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.
MicrosoftGraphOAuth2PermissionGrant withId(String id)

Set the id property: Read-only.
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.
MicrosoftGraphOAuth2PermissionGrant withResourceId(String resourceId)

Set the resourceId property: The id of the resource service principal to which access is authorized.
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).

Methods inherited from MicrosoftGraphEntity

additionalProperties fromJson id toJson validate withAdditionalProperties withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MicrosoftGraphOAuth2PermissionGrant

public MicrosoftGraphOAuth2PermissionGrant()

Creates an instance of MicrosoftGraphOAuth2PermissionGrant class.

Method Details

additionalProperties

public Map additionalProperties()

Get the additionalProperties property: oAuth2PermissionGrant.

Overrides:

MicrosoftGraphOAuth2PermissionGrant.additionalProperties()

Returns:

the additionalProperties value.

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.

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.

fromJson

public static MicrosoftGraphOAuth2PermissionGrant fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftGraphOAuth2PermissionGrant from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MicrosoftGraphOAuth2PermissionGrant if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the MicrosoftGraphOAuth2PermissionGrant.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MicrosoftGraphOAuth2PermissionGrant.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

MicrosoftGraphOAuth2PermissionGrant.validate()

withAdditionalProperties

public MicrosoftGraphOAuth2PermissionGrant withAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: oAuth2PermissionGrant.

Overrides:

MicrosoftGraphOAuth2PermissionGrant.withAdditionalProperties(Map<String,Object> additionalProperties)

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the MicrosoftGraphOAuth2PermissionGrant object itself.

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.

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.

withId

public MicrosoftGraphOAuth2PermissionGrant withId(String id)

Set the id property: Read-only.

Overrides:

MicrosoftGraphOAuth2PermissionGrant.withId(String id)

Parameters:

id

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.

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.

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.

Applies to