com.authlete.common.dto

Class UserInfoIssueRequest

java.lang.Object

com.authlete.common.dto.UserInfoIssueRequest

All Implemented Interfaces:

Serializable

public class UserInfoIssueRequest
extends Object
implements Serializable

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

token (REQUIRED)

The access token that has been passed to the service's userinfo endpoint by the client application. In other words, the access token which was contained in the userinfo request.

claims (OPTIONAL)

Claims in JSON format. As for the format, see setClaims(String) and "OpenID Connect Core 1.0, 5.1. Standard Claims".

sub (OPTIONAL)

The value of the sub claim. If the value of this request parameter is not empty, it is used as the value of the 'sub' claim. Otherwise, the value of the subject associated with the access token is used.

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserInfoIssueRequest()

Method Summary

Modifier and Type	Method and Description
String	getClaims() Get the claims of the subject in JSON format.
String	getSub() Get the value of the sub claim.
String	getToken() Get the access token which has come along with the userinfo request from the client application.
UserInfoIssueRequest	setClaims(Map<String,Object> claims) Set the value of "claims" which is the claims of the subject.
UserInfoIssueRequest	setClaims(String claims) Set the claims of the subject in JSON format.
UserInfoIssueRequest	setSub(String sub) Set the value of the sub claim.
UserInfoIssueRequest	setToken(String token) Set the access token which has been issued by Authlete.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInfoIssueRequest

public UserInfoIssueRequest()

Method Detail

getToken

public String getToken()

Get the access token which has come along with the userinfo request from the client application.

setToken

public UserInfoIssueRequest setToken(String token)

Set the access token which has been issued by Authlete. The access token is the one that has come along with the userinfo request from the client application.

getClaims

public String getClaims()

Get the claims of the subject in JSON format.

Returns:

The claims of the subject in JSON format. See the description of setClaims(String) for details about the format.

See Also:

setClaims(String)

setClaims

public UserInfoIssueRequest setClaims(String claims)

Set the claims of the subject in JSON format.

The service implementation is required to retrieve claims of the subject (= information about the end-user) from its database and format them in JSON format.

For example, if "given_name" claim, "family_name" claim and "email" claim are requested, the service implementation should generate a JSON object like the following:

 {
   "given_name": "Takahiko",
   "family_name": "Kawasaki",
   "email": "takahiko.kawasaki@example.com"
 }
 

and set its String representation by this method.

See OpenID Connect Core 1.0, 5.1. Standard Claims for further details about the format.

Parameters:

claims - The claims of the subject in JSON format.

Returns:

this object.

See Also:

OpenID Connect Core 1.0, 5.1. Standard Claims

setClaims

public UserInfoIssueRequest setClaims(Map<String,Object> claims)

Set the value of "claims" which is the claims of the subject. The argument is converted into a JSON string and passed to setClaims(String) method.

Parameters:

claims - The claims of the subject. Keys are claim names.

Returns:

this object.

Since:

1.24

getSub

public String getSub()

Get the value of the sub claim. If this method returns a non-empty value, it is used as the value of the 'sub' claim. Otherwise, the value of the subject associated with the access token is used.

Returns:

The value of the sub claim.

Since:

1.35

setSub

public UserInfoIssueRequest setSub(String sub)

Set the value of the sub claim. If a non-empty value is given, it is used as the value of the 'sub' claim. Otherwise, the value of the subject associated with the access token is used.

Parameters:

sub - The value of the sub claim.

Returns:

this object.

Since:

1.35