com.authlete.common.dto

Class TokenIssueRequest

java.lang.Object

com.authlete.common.dto.TokenIssueRequest

All Implemented Interfaces:

Serializable

public class TokenIssueRequest
extends Object
implements Serializable

Request to Authlete's /auth/token/issue API.

ticket (REQUIRED)

The ticket issued by Authlete's /auth/token API to the service implementation. It is the value of "ticket" contained in the response from Authlete's /auth/token API (TokenResponse).

subject (REQUIRED)

The subject (= unique identifier) of the authenticated user.

properties (OPTIONAL)

Extra properties to associate with a newly created access token. Note that properties parameter is accepted only when Content-Type of the request is application/json, so don't use application/x-www-form-urlencoded if you want to specify properties

subject request parameter was added as a required parameter on version 1.13.

Author:

Takahiko Kawasaki

See Also:

TokenResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenIssueRequest()

Method Summary

Modifier and Type	Method and Description
Property[]	getProperties() Get the extra properties to associate with an access token which will be issued by this request.
String	getSubject() Get the value of "subject" which is the unique identifier of the authenticated user.
String	getTicket() Get the value of "ticket" which is the ticket issued by Authlete's /auth/token API to the service implementation.
TokenIssueRequest	setProperties(Property[] properties) Set extra properties to associate with an access token which will be issued by this request.
TokenIssueRequest	setSubject(String subject) Set the value of "subject" which is the unique identifier of the authenticated user.
TokenIssueRequest	setTicket(String ticket) Set the value of "ticket" which is the ticket issued by Authlete's /auth/token API to the service implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenIssueRequest

public TokenIssueRequest()

Method Detail

getTicket

public String getTicket()

Get the value of "ticket" which is the ticket issued by Authlete's /auth/token API to the service implementation.

Returns:

The ticket.

setTicket

public TokenIssueRequest setTicket(String ticket)

Set the value of "ticket" which is the ticket issued by Authlete's /auth/token API to the service implementation.

Parameters:

ticket - The ticket.

Returns:

this object.

getSubject

public String getSubject()

Get the value of "subject" which is the unique identifier of the authenticated user.

Returns:

The subject of the authenticated user.

Since:

1.13

setSubject

public TokenIssueRequest setSubject(String subject)

Set the value of "subject" which is the unique identifier of the authenticated user.

Parameters:

subject - The subject of the authenticated user.

Returns:

this object.

Since:

1.13

getProperties

public Property[] getProperties()

Get the extra properties to associate with an access token which will be issued by this request.

Returns:

Extra properties.

Since:

1.30

setProperties

public TokenIssueRequest setProperties(Property[] properties)

Set extra properties to associate with an access token which will be issued by this request.

Keys of extra properties will be used as labels of top-level entries in a JSON response containing an access token which is returned from an authorization server. An example is example_parameter, which you can find in 5.1. Successful Response in RFC 6749. The following code snippet is an example to set one extra property having example_parameter as its key and example_value as its value.

 Property[] properties = { new Property("example_parameter", "example_value") };
 request.setProperties(properties);
 

Keys listed below should not be used and they would be ignored on the server side even if they were used. It's because they are reserved in RFC 6749 and OpenID Connect Core 1.0.

• access_token
• token_type
• expires_in
• refresh_token
• scope
• error
• error_description
• error_uri
• id_token

Note that there is an upper limit on the total size of extra properties. On the server side, the properties will be (1) converted to a multidimensional string array, (2) converted to JSON, (3) encrypted by AES/CBC/PKCS5Padding, (4) encoded by base64url, and then stored into the database. The length of the resultant string must not exceed 65,535 in bytes. This is the upper limit, but we think it is big enough.

Parameters:

properties - Extra properties.

Returns:

this object.

Since:

1.30