ClientCredentialParameters Class

  • Reference
Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.15.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

Implements

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class ClientCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Object containing parameters for client credential flow. Can be used as parameter to acquireToken(ClientCredentialParameters parameters)

Method Summary

Modifier and Type Method and Description
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Builder for ClientCredentialParameters
ClaimsRequest claims()

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
IClientCredential clientCredential()

Overrides the client credentials for this request
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Adds additional headers to the token request
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Adds additional query parameters to the token request
@lombok.NonNull java.util.Set<java.lang.String> scopes()

Scopes for which the application is requesting access to.
java.lang.Boolean skipCache()

Indicates whether the request should skip looking into the token cache.
java.lang.String tenant()

Overrides the tenant value in the authority URL for this request

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

builder

public static ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set scopes)

Builder for ClientCredentialParameters

Parameters:

scopes - scopes application is requesting access to

Returns:

builder that can be used to construct ClientCredentialParameters

claims

public ClaimsRequest claims()

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims

clientCredential

public IClientCredential clientCredential()

Overrides the client credentials for this request

extraHttpHeaders

public Map extraHttpHeaders()

Adds additional headers to the token request

extraQueryParameters

public Map extraQueryParameters()

Adds additional query parameters to the token request

scopes

public @NonNull Set scopes()

Scopes for which the application is requesting access to.

skipCache

public Boolean skipCache()

Indicates whether the request should skip looking into the token cache. Be default it is set to false.

tenant

public String tenant()

Overrides the tenant value in the authority URL for this request

Applies to