# Package org.apache.hc.client5.http.auth

Client HTTP authentication APIs.

See: Description

Interface Summary
Interface | Description
--- | ---
AuthCache | This interface represents an cache of `AuthScheme` state information that can be re-used for preemptive authentication by subsequent requests.
AuthScheme | This interface represents an abstract challenge-response oriented authentication scheme.
AuthSchemeFactory | Factory for `AuthScheme` implementations.
Credentials | This interface represents a set of credentials consisting of a security principal and a secret (password) that can be used to establish user identity
CredentialsProvider | Provider of authentication credentials.
CredentialsStore | Abstract store of authentication credentials.

Class Summary
Class | Description
--- | ---
AuthChallenge | This class represents an authentication challenge consisting of a auth scheme and either a single parameter or a list of name / value pairs.
AuthExchange | This class represents the actual state of authentication handshake including the current `AuthScheme` used for request authorization as well as a collection of backup authentication options if available.
AuthScope | `AuthScope` represents an authentication scope consisting of an application protocol, a host name, a port number, a realm name and an authentication scheme name.
BasicUserPrincipal | Basic username based principal representation.
KerberosConfig | Immutable class encapsulating Kerberos configuration options.
KerberosConfig.Builder |
KerberosCredentials | Kerberos specific `Credentials` representation based on `GSSCredential`.
NTCredentials | Microsoft Windows specific `Credentials` representation that includes Windows specific attributes such as name of the domain the user belongs to.
NTUserPrincipal | Microsoft Windows specific user principal implementation.
StandardAuthScheme | Authentication schemes by their names supported by the HttpClient.
UsernamePasswordCredentials | Simple `Credentials` representation based on a user name / password pair.

Enum Summary
Enum | Description
--- | ---
AuthExchange.State |
ChallengeType | Challenge type (TARGET or PROXY)
KerberosConfig.Option |

Exception Summary
Exception | Description
--- | ---
AuthenticationException | Signals a failure in authentication process
InvalidCredentialsException | Authentication credentials required to respond to a authentication challenge are invalid
MalformedChallengeException | Signals that authentication challenge is in some way invalid or illegal in the given context

Annotation Types Summary
Annotation Type | Description
--- | ---
AuthStateCacheable | Indicates that the state of an `AuthScheme` can be cached and re-used for preemptive authentication by subsequent requests.

## Package org.apache.hc.client5.http.auth Description

Client HTTP authentication APIs.