|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
ErrorResponse | Response message indicating an error. |
Message | Marker interface for OAuth 2.0 authorisation framework messages. |
Request | Request message, serialises to an HTTP request. |
Response | Response message, serialises to an HTTP response. |
SuccessResponse | Response message indicating success. |
Class Summary | |
---|---|
AccessTokenRequest | Access token request to the Token endpoint. |
AccessTokenResponse | Access token response from the Token endpoint. |
AuthorizationCode | Authorisation code. |
AuthorizationErrorResponse | Authorisation error response. |
AuthorizationRequest | Authorisation request. |
AuthorizationResponse | The base abstract class for authorisation success and error responses. |
AuthorizationSuccessResponse | Authorisation success response. |
ErrorObject | Error object, used to encapsulate OAuth 2.0 and other errors. |
GrantType | Authorisation grant type. |
OAuth2Error | OAuth 2.0 authorisation and token endpoint errors. |
ProtectedResourceRequest | Base abstract class for protected resource requests using an OAuth 2.0 access token. |
RefreshTokenRequest | Refresh token request to the Token endpoint. |
ResponseType | Authorisation response type. |
ResponseType.Value | Authorisation response type value. |
Scope | Authorisation scope. |
Scope.Value | Authorisation scope value. |
TokenErrorResponse | OAuth 2.0 Token error response. |
TokenRequest | The base abstract class for access token and refresh token requests to the Token endpoint. |
TokenResponse | Token endpoint response. |
Enum Summary | |
---|---|
ClientType | Enumeration of OAuth 2.0 client types. |
Role | Enumeration of OAuth 2.0 roles. |
Scope.Value.Requirement | Enumeration of the scope value requirements for application-specific authorisation requests. |
Exception Summary | |
---|---|
GeneralException | The base class for exceptions defined in this SDK. |
ParseException | Parse exception. |
SerializeException | Serialization exception. |
Classes for representing, serialising and parsing OAuth 2.0 client requests and server responses.
Authorisation endpoint messages:
AuthorizationRequest
The client
requests the end-user's authorisation to access a protected
resource.
AuthorizationResponse
The server
grants the authorisation or returns an error:
AuthorizationSuccessResponse
The server responds with an authorisation grant.
AuthorizationErrorResponse
The server responds with an authorisation error.
Token endpoint messages:
TokenRequest
The client
authenticates with the server and requests and access token based on
a previously issued authorisation code or refresh token:
AccessTokenRequest
The
client requests the authorisation code to be exchanged for
an access and refresh token.
RefreshTokenRequest
The
client requests a new access token.
TokenResponse
The server responds
with an access token or returns an error:
AccessTokenResponse
The
server responds with an access token and optional refresh
token.
TokenErrorResponse
The
server responds with a token error.
Protected resource messages:
ProtectedResourceRequest
The client
makes a request to a protected resource using an OAuth 2.0 access
token.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |