Class MicrosoftGraphApiApplication
- java.lang.Object
-
- com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphApiApplication
-
public final class MicrosoftGraphApiApplication extends Object
apiApplication.
-
-
Constructor Summary
Constructors Constructor Description MicrosoftGraphApiApplication()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
acceptMappedClaims()
Get the acceptMappedClaims property: When true, allows an application to use claims mapping without specifying a custom signing key.Map<String,Object>
additionalProperties()
Get the additionalProperties property: apiApplication.List<UUID>
knownClientApplications()
Get the knownClientApplications property: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.List<MicrosoftGraphPermissionScope>
oauth2PermissionScopes()
Get the oauth2PermissionScopes property: The definition of the delegated permissions exposed by the web API represented by this application registration.List<MicrosoftGraphPreAuthorizedApplication>
preAuthorizedApplications()
Get the preAuthorizedApplications property: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs.Integer
requestedAccessTokenVersion()
Get the requestedAccessTokenVersion property: Specifies the access token version expected by this resource.void
validate()
Validates the instance.MicrosoftGraphApiApplication
withAcceptMappedClaims(Boolean acceptMappedClaims)
Set the acceptMappedClaims property: When true, allows an application to use claims mapping without specifying a custom signing key.MicrosoftGraphApiApplication
withAdditionalProperties(Map<String,Object> additionalProperties)
Set the additionalProperties property: apiApplication.MicrosoftGraphApiApplication
withKnownClientApplications(List<UUID> knownClientApplications)
Set the knownClientApplications property: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app.MicrosoftGraphApiApplication
withOauth2PermissionScopes(List<MicrosoftGraphPermissionScope> oauth2PermissionScopes)
Set the oauth2PermissionScopes property: The definition of the delegated permissions exposed by the web API represented by this application registration.MicrosoftGraphApiApplication
withPreAuthorizedApplications(List<MicrosoftGraphPreAuthorizedApplication> preAuthorizedApplications)
Set the preAuthorizedApplications property: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs.MicrosoftGraphApiApplication
withRequestedAccessTokenVersion(Integer requestedAccessTokenVersion)
Set the requestedAccessTokenVersion property: Specifies the access token version expected by this resource.
-
-
-
Method Detail
-
acceptMappedClaims
public Boolean acceptMappedClaims()
Get the acceptMappedClaims property: When true, allows an application to use claims mapping without specifying a custom signing key.- Returns:
- the acceptMappedClaims value.
-
withAcceptMappedClaims
public MicrosoftGraphApiApplication withAcceptMappedClaims(Boolean acceptMappedClaims)
Set the acceptMappedClaims property: When true, allows an application to use claims mapping without specifying a custom signing key.- Parameters:
acceptMappedClaims
- the acceptMappedClaims value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
knownClientApplications
public List<UUID> knownClientApplications()
Get the knownClientApplications property: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant.- Returns:
- the knownClientApplications value.
-
withKnownClientApplications
public MicrosoftGraphApiApplication withKnownClientApplications(List<UUID> knownClientApplications)
Set the knownClientApplications property: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant.- Parameters:
knownClientApplications
- the knownClientApplications value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
oauth2PermissionScopes
public List<MicrosoftGraphPermissionScope> oauth2PermissionScopes()
Get the oauth2PermissionScopes property: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes.- Returns:
- the oauth2PermissionScopes value.
-
withOauth2PermissionScopes
public MicrosoftGraphApiApplication withOauth2PermissionScopes(List<MicrosoftGraphPermissionScope> oauth2PermissionScopes)
Set the oauth2PermissionScopes property: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes.- Parameters:
oauth2PermissionScopes
- the oauth2PermissionScopes value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
preAuthorizedApplications
public List<MicrosoftGraphPreAuthorizedApplication> preAuthorizedApplications()
Get the preAuthorizedApplications property: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent.- Returns:
- the preAuthorizedApplications value.
-
withPreAuthorizedApplications
public MicrosoftGraphApiApplication withPreAuthorizedApplications(List<MicrosoftGraphPreAuthorizedApplication> preAuthorizedApplications)
Set the preAuthorizedApplications property: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent.- Parameters:
preAuthorizedApplications
- the preAuthorizedApplications value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
requestedAccessTokenVersion
public Integer requestedAccessTokenVersion()
Get the requestedAccessTokenVersion property: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2.- Returns:
- the requestedAccessTokenVersion value.
-
withRequestedAccessTokenVersion
public MicrosoftGraphApiApplication withRequestedAccessTokenVersion(Integer requestedAccessTokenVersion)
Set the requestedAccessTokenVersion property: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2.- Parameters:
requestedAccessTokenVersion
- the requestedAccessTokenVersion value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
additionalProperties
public Map<String,Object> additionalProperties()
Get the additionalProperties property: apiApplication.- Returns:
- the additionalProperties value.
-
withAdditionalProperties
public MicrosoftGraphApiApplication withAdditionalProperties(Map<String,Object> additionalProperties)
Set the additionalProperties property: apiApplication.- Parameters:
additionalProperties
- the additionalProperties value to set.- Returns:
- the MicrosoftGraphApiApplication object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-