com.authlete.common.dto

Class TokenRequest

java.lang.Object

com.authlete.common.dto.TokenRequest

All Implemented Interfaces:

Serializable

public class TokenRequest
extends Object
implements Serializable

Request to Authlete's /auth/token API.

parameters (REQUIRED)

OAuth 2.0 token request parameters which are the request parameters that the OAuth 2.0 token endpoint of the service implementation received from the client application.

The value of "parameters" is the entire entity body (which is formatted in application/x-www-form-urlencoded) of the request from the client application.

clientId (OPTIONAL)

The client ID extracted from Authorization header of the token request from the client application.

If the token endpoint of the service implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client ID in Authorization header, the value should be extracted and set to this parameter.

clientSecret (OPTIONAL)

The client secret extracted from Authorization header of the token request from the client application.

If the token endpoint of the service implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client secret in Authorization header, the value should be extracted and set to this parameter.

An entity body of a token request may contain the client ID (client_id) and the client secret (client_secret) along with other request parameters as described in RFC 6749, 2.3.1. Client Password. If the client credentials are contained in both Authorization header and the entity body, they must be identical. Otherwise, Authlete's /auth/token API generates an error (it's not a service error but a client error).

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenRequest()

Method Summary

Modifier and Type	Method and Description
String	getClientId() Get the client ID extracted from Authorization header of the token request from the client application.
String	getClientSecret() Get the client secret extracted from Authorization header of the token request from the client application.
String	getParameters() Get the value of "parameters" which are the request parameters that the OAuth 2.0 token endpoint of the service implementation received from the client application.
TokenRequest	setClientId(String clientId) Set the client ID extracted from Authorization header of the token request from the client application.
TokenRequest	setClientSecret(String clientSecret) Set the client secret extracted from Authorization header of the token request from the client application.
TokenRequest	setParameters(String parameters) Set the value of "parameters" which are the request parameters that the OAuth 2.0 token endpoint of the service implementation received from the client application.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenRequest

public TokenRequest()

Method Detail

getParameters

public String getParameters()

Get the value of "parameters" which are the request parameters that the OAuth 2.0 token endpoint of the service implementation received from the client application.

setParameters

public TokenRequest setParameters(String parameters)

Set the value of "parameters" which are the request parameters that the OAuth 2.0 token endpoint of the service implementation received from the client application.

getClientId

public String getClientId()

Get the client ID extracted from Authorization header of the token request from the client application.

setClientId

public TokenRequest setClientId(String clientId)

Set the client ID extracted from Authorization header of the token request from the client application.

getClientSecret

public String getClientSecret()

Get the client secret extracted from Authorization header of the token request from the client application.

setClientSecret

public TokenRequest setClientSecret(String clientSecret)

Set the client secret extracted from Authorization header of the token request from the client application.