com.nimbusds.oauth2.sdk

Class JWTBearerGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.AssertionGrant

com.nimbusds.oauth2.sdk.JWTBearerGrant

@Immutable
public final class JWTBearerGrant
extends AssertionGrant

JWT bearer grant. Used in access token requests with a JSON Web Token (JWT), such an OpenID Connect ID token.

Related specifications:

• JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (draft-ietf-oauth-jwt-bearer-10), section-2.1.
• Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants (draft-ietf-oauth-assertions-16), section 4.1.

Field Summary

Fields

Modifier and Type	Field and Description
static GrantType	GRANT_TYPE The grant type.

Constructor Summary

Constructors

Constructor and Description
JWTBearerGrant(com.nimbusds.jwt.JWT assertion) Creates a new JSON Web Token (JWT) bearer assertion grant.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAssertion() Gets the assertion.
com.nimbusds.jwt.JWT	getJWTAssertion() Gets the JSON Web Token (JWT) bearer assertion.
static JWTBearerGrant	parse(Map<String,String> params) Parses a JWT bearer grant from the specified parameters.
Map<String,String>	toParameters() Return the parameters for the authorisation grant.

Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationGrant

getType

Methods inherited from class java.lang.Object

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

Field Detail

GRANT_TYPE

public static final GrantType GRANT_TYPE

The grant type.

Constructor Detail

JWTBearerGrant

public JWTBearerGrant(com.nimbusds.jwt.JWT assertion)

Creates a new JSON Web Token (JWT) bearer assertion grant.

Parameters:

assertion - The JSON Web Token (JWT) assertion. Must not be null.

Method Detail

getJWTAssertion

public com.nimbusds.jwt.JWT getJWTAssertion()

Gets the JSON Web Token (JWT) bearer assertion.

Returns:

The JWT bearer assertion.

getAssertion

public String getAssertion()

Description copied from class: AssertionGrant

Gets the assertion.

Specified by:

getAssertion in class AssertionGrant

Returns:

The assertion as a string.

toParameters

public Map<String,String> toParameters()

Description copied from class: AuthorizationGrant

Return the parameters for the authorisation grant.

Specified by:

toParameters in class AuthorizationGrant

Returns:

The parameters.

parse

public static JWTBearerGrant parse(Map<String,String> params)
                            throws ParseException

Parses a JWT bearer grant from the specified parameters.

Example:

 grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer
 &assertion=eyJhbGciOiJFUzI1NiJ9.eyJpc3Mi[...omitted for brevity...].
 J9l-ZhwP[...omitted for brevity...]
 

Parameters:

params - The parameters.

Returns:

The JWT bearer grant.

Throws:

ParseException - If parsing failed.