azure-docs-sdk-java/docs-ref-autogen/com.microsoft.identity.clie...

283 строки
22 KiB
YAML

### YamlMime:JavaType
constructors:
- fullName: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String errorCode)
name: MsalClientException(final String errorCode)
nameWithType: MsalClientException.MsalClientException(final String errorCode)
parameters:
- name: errorCode
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
syntax: public MsalClientException(final String errorCode)
uid: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String)
- fullName: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String errorCode, final String errorMessage)
name: MsalClientException(final String errorCode, final String errorMessage)
nameWithType: MsalClientException.MsalClientException(final String errorCode, final String errorMessage)
parameters:
- name: errorCode
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
- name: errorMessage
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
syntax: public MsalClientException(final String errorCode, final String errorMessage)
uid: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String,final String)
- fullName: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String errorCode, final String errorMessage, final Throwable throwable)
name: MsalClientException(final String errorCode, final String errorMessage, final Throwable throwable)
nameWithType: MsalClientException.MsalClientException(final String errorCode, final String errorMessage, final Throwable throwable)
parameters:
- name: errorCode
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
- name: errorMessage
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
- name: throwable
type: <xref href="final+Throwable?alt=final+Throwable&text=final+Throwable" data-throw-if-not-resolved="False"/>
syntax: public MsalClientException(final String errorCode, final String errorMessage, final Throwable throwable)
uid: com.microsoft.identity.client.exception.MsalClientException.MsalClientException(final String,final String,final Throwable)
fields:
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.APP_MANIFEST_VALIDATION_ERROR
name: APP_MANIFEST_VALIDATION_ERROR
nameWithType: MsalClientException.APP_MANIFEST_VALIDATION_ERROR
summary: <p>Developer error. Application manifest is not properly configured to support MSAL. </p>
syntax: public static final String APP_MANIFEST_VALIDATION_ERROR= "app_manifest_validation_error"
uid: com.microsoft.identity.client.exception.MsalClientException.APP_MANIFEST_VALIDATION_ERROR
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.AUTHORITY_VALIDATION_NOT_SUPPORTED
name: AUTHORITY_VALIDATION_NOT_SUPPORTED
nameWithType: MsalClientException.AUTHORITY_VALIDATION_NOT_SUPPORTED
summary: <p>The authority is not supported for authority validation. The sdk supports b2c authority, but we don't support b2c authority validation yet. Only well-known host will be supported. </p>
syntax: public static final String AUTHORITY_VALIDATION_NOT_SUPPORTED= ClientException.AUTHORITY_VALIDATION_NOT_SUPPORTED
uid: com.microsoft.identity.client.exception.MsalClientException.AUTHORITY_VALIDATION_NOT_SUPPORTED
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.BROKER_BIND_FAILURE
name: BROKER_BIND_FAILURE
nameWithType: MsalClientException.BROKER_BIND_FAILURE
summary: <p>Failed to bind the service in broker app. </p>
syntax: public static final String BROKER_BIND_FAILURE= ErrorStrings.BROKER_BIND_SERVICE_FAILED
uid: com.microsoft.identity.client.exception.MsalClientException.BROKER_BIND_FAILURE
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.BROKER_NOT_INSTALLED
name: BROKER_NOT_INSTALLED
nameWithType: MsalClientException.BROKER_NOT_INSTALLED
summary: <p>Broker app is not installed. </p>
syntax: public static final String BROKER_NOT_INSTALLED= "broker_not_installed"
uid: com.microsoft.identity.client.exception.MsalClientException.BROKER_NOT_INSTALLED
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.CHROME_NOT_INSTALLED
name: CHROME_NOT_INSTALLED
nameWithType: MsalClientException.CHROME_NOT_INSTALLED
summary: '<p>Note: after MSAL 0.2.0 this error is no longer relevant. chrome_not_installed: Chrome is not installed on the device. The sdk uses chrome custom tab for authorization requests if available, and will fall back to chrome browser. </p>'
syntax: public static final String CHROME_NOT_INSTALLED= "chrome_not_installed"
uid: com.microsoft.identity.client.exception.MsalClientException.CHROME_NOT_INSTALLED
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.CURRENT_ACCOUNT_MISMATCH
name: CURRENT_ACCOUNT_MISMATCH
nameWithType: MsalClientException.CURRENT_ACCOUNT_MISMATCH
summary: <p>The account that is being signed in does not match with the provided account. </p>
syntax: public static final String CURRENT_ACCOUNT_MISMATCH= "current_account_mismatch"
uid: com.microsoft.identity.client.exception.MsalClientException.CURRENT_ACCOUNT_MISMATCH
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE
name: CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE
nameWithType: MsalClientException.CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE
syntax: public static final String CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE= "The signed in account does not match with the provided account."
uid: com.microsoft.identity.client.exception.MsalClientException.CURRENT_ACCOUNT_MISMATCH_ERROR_MESSAGE
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.DEVICE_NETWORK_NOT_AVAILABLE
name: DEVICE_NETWORK_NOT_AVAILABLE
nameWithType: MsalClientException.DEVICE_NETWORK_NOT_AVAILABLE
summary: <p>No active network is available on the device. </p>
syntax: public static final String DEVICE_NETWORK_NOT_AVAILABLE= ClientException.DEVICE_NETWORK_NOT_AVAILABLE
uid: com.microsoft.identity.client.exception.MsalClientException.DEVICE_NETWORK_NOT_AVAILABLE
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.DUPLICATE_COMMAND
name: DUPLICATE_COMMAND
nameWithType: MsalClientException.DUPLICATE_COMMAND
summary: <p>Duplicate command. The same command is already be processed. </p>
syntax: public static final String DUPLICATE_COMMAND= "duplicate_command"
uid: com.microsoft.identity.client.exception.MsalClientException.DUPLICATE_COMMAND
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.DUPLICATE_QUERY_PARAMETER
name: DUPLICATE_QUERY_PARAMETER
nameWithType: MsalClientException.DUPLICATE_QUERY_PARAMETER
summary: <p>Extra query parameters set by the client app is already sent by the sdk. </p>
syntax: public static final String DUPLICATE_QUERY_PARAMETER= ClientException.DUPLICATE_QUERY_PARAMETER
uid: com.microsoft.identity.client.exception.MsalClientException.DUPLICATE_QUERY_PARAMETER
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.INVALID_JWT
name: INVALID_JWT
nameWithType: MsalClientException.INVALID_JWT
summary: <p>JWT returned by the server is not valid, empty or malformed. </p>
syntax: public static final String INVALID_JWT= ClientException.INVALID_JWT
uid: com.microsoft.identity.client.exception.MsalClientException.INVALID_JWT
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.INVALID_PARAMETER
name: INVALID_PARAMETER
nameWithType: MsalClientException.INVALID_PARAMETER
summary: <p>The parameter provided by the user is invalid. </p>
syntax: public static final String INVALID_PARAMETER= "invalid_parameter"
uid: com.microsoft.identity.client.exception.MsalClientException.INVALID_PARAMETER
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.IO_ERROR
name: IO_ERROR
nameWithType: MsalClientException.IO_ERROR
summary: <p>IOException happened, could be the device/network errors. </p>
syntax: public static final String IO_ERROR= ClientException.IO_ERROR
uid: com.microsoft.identity.client.exception.MsalClientException.IO_ERROR
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.JSON_PARSE_FAILURE
name: JSON_PARSE_FAILURE
nameWithType: MsalClientException.JSON_PARSE_FAILURE
summary: <p>The sdk failed to parse the Json format. </p>
syntax: public static final String JSON_PARSE_FAILURE= ClientException.JSON_PARSE_FAILURE
uid: com.microsoft.identity.client.exception.MsalClientException.JSON_PARSE_FAILURE
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.MALFORMED_URL
name: MALFORMED_URL
nameWithType: MsalClientException.MALFORMED_URL
summary: <p>The url is malformed. Likely caused when constructing the auth request, authority, or redirect URI. </p>
syntax: public static final String MALFORMED_URL= ClientException.MALFORMED_URL
uid: com.microsoft.identity.client.exception.MsalClientException.MALFORMED_URL
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.MULTIPLE_MATCHING_TOKENS_DETECTED
name: MULTIPLE_MATCHING_TOKENS_DETECTED
nameWithType: MsalClientException.MULTIPLE_MATCHING_TOKENS_DETECTED
summary: <p>There are multiple cache entries found, the sdk cannot pick the correct access token or refresh token from the cache. Likely it's a bug in the sdk when caching tokens or authority is not proviced in the silent request and multiple tokens were found. </p>
syntax: public static final String MULTIPLE_MATCHING_TOKENS_DETECTED= ClientException.MULTIPLE_MATCHING_TOKENS_DETECTED
uid: com.microsoft.identity.client.exception.MsalClientException.MULTIPLE_MATCHING_TOKENS_DETECTED
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.NO_CURRENT_ACCOUNT
name: NO_CURRENT_ACCOUNT
nameWithType: MsalClientException.NO_CURRENT_ACCOUNT
summary: <p>No account currently signed in to SingleAccountPublicClientApplication </p>
syntax: public static final String NO_CURRENT_ACCOUNT= "no_current_account"
uid: com.microsoft.identity.client.exception.MsalClientException.NO_CURRENT_ACCOUNT
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.NO_CURRENT_ACCOUNT_ERROR_MESSAGE
name: NO_CURRENT_ACCOUNT_ERROR_MESSAGE
nameWithType: MsalClientException.NO_CURRENT_ACCOUNT_ERROR_MESSAGE
syntax: public static final String NO_CURRENT_ACCOUNT_ERROR_MESSAGE= "There is no signed in account."
uid: com.microsoft.identity.client.exception.MsalClientException.NO_CURRENT_ACCOUNT_ERROR_MESSAGE
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.NO_SUCH_ALGORITHM
name: NO_SUCH_ALGORITHM
nameWithType: MsalClientException.NO_SUCH_ALGORITHM
summary: <p>The algorithm used to generate pkce challenge is not supported. </p>
syntax: public static final String NO_SUCH_ALGORITHM= ClientException.NO_SUCH_ALGORITHM
uid: com.microsoft.identity.client.exception.MsalClientException.NO_SUCH_ALGORITHM
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.NOT_ELIGIBLE_TO_USE_BROKER
name: NOT_ELIGIBLE_TO_USE_BROKER
nameWithType: MsalClientException.NOT_ELIGIBLE_TO_USE_BROKER
summary: <p>Not eligible to use Broker. </p>
syntax: public static final String NOT_ELIGIBLE_TO_USE_BROKER= "not_eligible_to_use_broker"
uid: com.microsoft.identity.client.exception.MsalClientException.NOT_ELIGIBLE_TO_USE_BROKER
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.REDIRECT_URI_VALIDATION_ERROR
name: REDIRECT_URI_VALIDATION_ERROR
nameWithType: MsalClientException.REDIRECT_URI_VALIDATION_ERROR
summary: <p>Developer error. The redirect URI in the configuration file doesn't match with the one generated with package name and signature hash. </p>
syntax: public static final String REDIRECT_URI_VALIDATION_ERROR= "redirect_uri_validation_error"
uid: com.microsoft.identity.client.exception.MsalClientException.REDIRECT_URI_VALIDATION_ERROR
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.SAPCA_USE_WITH_MULTI_POLICY_B2C
name: SAPCA_USE_WITH_MULTI_POLICY_B2C
nameWithType: MsalClientException.SAPCA_USE_WITH_MULTI_POLICY_B2C
summary: <p>Configuration error. SingleAccount apps cannot be used with multiple B2C policies, as each policy creates a separate Account. </p>
syntax: public static final String SAPCA_USE_WITH_MULTI_POLICY_B2C= "SingleAccountPublicClientApplication cannot be used with multiple B2C policies."
uid: com.microsoft.identity.client.exception.MsalClientException.SAPCA_USE_WITH_MULTI_POLICY_B2C
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.SCOPE_EMPTY_OR_NULL
name: SCOPE_EMPTY_OR_NULL
nameWithType: MsalClientException.SCOPE_EMPTY_OR_NULL
summary: <p>A scope is required when making a token request </p>
syntax: public static final String SCOPE_EMPTY_OR_NULL= ClientException.SCOPE_EMPTY_OR_NULL
uid: com.microsoft.identity.client.exception.MsalClientException.SCOPE_EMPTY_OR_NULL
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.STATE_MISMATCH
name: STATE_MISMATCH
nameWithType: MsalClientException.STATE_MISMATCH
summary: <p>State from authorization response did not match the state in the authorization request. For authorization requests, the sdk will verify the state returned from redirect and the one sent in the request. </p>
syntax: public static final String STATE_MISMATCH= ClientException.STATE_MISMATCH
uid: com.microsoft.identity.client.exception.MsalClientException.STATE_MISMATCH
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.UNKNOWN_AUTHORITY
name: UNKNOWN_AUTHORITY
nameWithType: MsalClientException.UNKNOWN_AUTHORITY
summary: <p>The authority is unknown. Occurs when the authority is not part of configuration or the authority host is not recognized by Microsoft. </p>
syntax: public static final String UNKNOWN_AUTHORITY= ClientException.UNKNOWN_AUTHORITY
uid: com.microsoft.identity.client.exception.MsalClientException.UNKNOWN_AUTHORITY
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.UNKNOWN_ERROR
name: UNKNOWN_ERROR
nameWithType: MsalClientException.UNKNOWN_ERROR
summary: <p>Extra query parameters set by the client app is already sent by the sdk. </p>
syntax: public static final String UNKNOWN_ERROR= ClientException.UNKNOWN_ERROR
uid: com.microsoft.identity.client.exception.MsalClientException.UNKNOWN_ERROR
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.UNSUPPORTED_ENCODING
name: UNSUPPORTED_ENCODING
nameWithType: MsalClientException.UNSUPPORTED_ENCODING
summary: <p>The encoding is not supported by the device. </p>
syntax: public static final String UNSUPPORTED_ENCODING= ClientException.UNSUPPORTED_ENCODING
uid: com.microsoft.identity.client.exception.MsalClientException.UNSUPPORTED_ENCODING
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.UNSUPPORTED_URL
name: UNSUPPORTED_URL
nameWithType: MsalClientException.UNSUPPORTED_URL
summary: <p>Unsupported url, cannot perform adfs authority validation. </p>
syntax: public static final String UNSUPPORTED_URL= ClientException.UNSUPPORTED_URL
uid: com.microsoft.identity.client.exception.MsalClientException.UNSUPPORTED_URL
- field:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.identity.client.exception.MsalClientException.USER_MISMATCH
name: USER_MISMATCH
nameWithType: MsalClientException.USER_MISMATCH
summary: <p>The user provided in the acquire token request doesn't match the user returned from server. </p>
syntax: public static final String USER_MISMATCH= ClientException.USER_MISMATCH
uid: com.microsoft.identity.client.exception.MsalClientException.USER_MISMATCH
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="BaseException" data-throw-if-not-resolved="False"/>
- <xref href="com.microsoft.identity.client.exception.MsalException?alt=com.microsoft.identity.client.exception.MsalException&text=MsalException" data-throw-if-not-resolved="False"/>
inheritedMembers:
- com.microsoft.identity.client.exception.MsalException.getErrorCode()
- com.microsoft.identity.client.exception.MsalException.getMessage()
nameWithType: MsalClientException
syntax: public class MsalClientException extends MsalException
type: class
uid: com.microsoft.identity.client.exception.MsalClientException
fullName: com.microsoft.identity.client.exception.MsalClientException
name: MsalClientException
package: com.microsoft.identity.client.exception
summary: >-
<p>This exception class represents general errors that are local to the library. Below is the table of proposed codes and a short description of each. </p>
<p>Set of error codes that could be returned from this exception: <ul><li><p>multiple_matching_tokens_detected: There are multiple cache entries found and the sdk cannot identify the correct access or refresh token from the cache. This usually indicates a bug in the sdk for storing tokens or the authority is not provided in the silent request and multiple matching tokens found. </p></li><li><p>device_network_not_available: No active network is available on the device. </p></li><li><p>json_parse_failure: The sdk failed to parse the JSON format. </p></li><li><p>io_error: IOException happened, could be the device/network errors. </p></li><li><p>malformed_url: The url is malformed. Likely caused when constructing the auth request, authority, or redirect URI. </p></li><li><p>unsupported_encoding: The encoding is not supported by the device. </p></li><li><p>no_such_algorithm: The algorithm used to generate pkce challenge is not supported. </p></li><li><p>invalid_jwt: JWT returned by the server is not valid, empty or malformed. </p></li><li><p>state_mismatch: State from authorization response did not match the state in the authorization request. For authorization requests, the sdk will verify the state returned from redirect and the one sent in the request. </p></li><li><p>unsupported_url: Unsupported url, cannot perform ADFS authority validation. </p></li><li><p>authority_validation_not_supported: The authority is not supported for authority validation. The sdk supports b2c authorities, but doesn't support b2c authority validation. Only well-known host will be supported. </p></li><li><p>chrome_not_installed: Chrome is not installed on the device. The sdk uses chrome custom tab for authorization requests if available, and will fall back to chrome browser. </p></li><li><p>user_mismatch: The user provided in the acquire token request doesn't match the user returned from server. </p></li></ul></p>
metadata: {}