Package com.nimbusds.oauth2.sdk

Class AssertionGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.AssertionGrant

Direct Known Subclasses:

JWTBearerGrant, SAML2BearerGrant

public abstract class AssertionGrant
extends AuthorizationGrant

Assertion grant. Used in access token requests with an assertion, such as a SAML 2.0 assertion or JSON Web Token (JWT).

Related specifications:

• Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants (RFC 7521), section 4.1.

Field Summary

Fields

Modifier and Type	Field	Description
protected static ParseException	MISSING_ASSERTION_PARAM_EXCEPTION	Caches missing assertion parameter exception.
protected static ParseException	MISSING_GRANT_TYPE_PARAM_EXCEPTION	Cached missing grant_type parameter exception.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AssertionGrant(GrantType type)	Creates a new assertion-based authorisation grant.

Method Summary

Modifier and Type	Method	Description
abstract String	getAssertion()	Gets the assertion.

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

getType, parse, toParameters

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_GRANT_TYPE_PARAM_EXCEPTION

protected static final ParseException MISSING_GRANT_TYPE_PARAM_EXCEPTION

Cached missing grant_type parameter exception.

MISSING_ASSERTION_PARAM_EXCEPTION

protected static final ParseException MISSING_ASSERTION_PARAM_EXCEPTION

Caches missing assertion parameter exception.

Constructor Detail

AssertionGrant

protected AssertionGrant(GrantType type)

Creates a new assertion-based authorisation grant.

Parameters:

type - The authorisation grant type. Must not be null.

Method Detail

getAssertion

public abstract String getAssertion()

Gets the assertion.

Returns:

The assertion as a string.