com.microsoft.identity.client.exception

Class MsalDeclinedScopeException

java.lang.Object

BaseException

com.microsoft.identity.client.exception.MsalException

com.microsoft.identity.client.exception.MsalDeclinedScopeException

public class MsalDeclinedScopeException
extends MsalException

Exception class to indicate that one or more requested scopes have been declined by the server. Developers can opt to continue acquiring token by passing the silentParametersForGrantedScopes and calling acquireTokenSilent call on this error.

Constructor Summary

Constructors

Constructor and Description
MsalDeclinedScopeException(java.util.List<java.lang.String> grantedScopes, java.util.List<java.lang.String> declinedScopes, AcquireTokenSilentParameters silentParametersForGrantedScopes)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDeclinedScopes() List of scopes declined by the server.
java.util.List<java.lang.String>	getGrantedScopes() List of scopes granted by the server.
AcquireTokenSilentParameters	getSilentParametersForGrantedScopes() Returns pre configured AcquireTokenSilentParameters from the original request to make a subsequent silent request for granted scopes.

Methods inherited from class com.microsoft.identity.client.exception.MsalException

getErrorCode, getMessage

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MsalDeclinedScopeException

public MsalDeclinedScopeException(java.util.List<java.lang.String> grantedScopes,
                                  java.util.List<java.lang.String> declinedScopes,
                                  AcquireTokenSilentParameters silentParametersForGrantedScopes)

Method Detail

getGrantedScopes

public java.util.List<java.lang.String> getGrantedScopes()

List of scopes granted by the server.

Returns:

List

getDeclinedScopes

public java.util.List<java.lang.String> getDeclinedScopes()

List of scopes declined by the server. This can happen due to multiple reasons. * Requested scope is not supported * Requested scope is not recognized (According to OIDC, any scope values used that are not understood by an implementation should be ignored.) * Requested scope is not supported for a particular account (Organizational scopes when it is a consumer account)

Returns:

List

getSilentParametersForGrantedScopes

public AcquireTokenSilentParameters getSilentParametersForGrantedScopes()

Returns pre configured AcquireTokenSilentParameters from the original request to make a subsequent silent request for granted scopes.

Returns:

AcquireTokenSilentParameters