com.nimbusds.oauth2.sdk

Class SAML2BearerGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.AssertionGrant

com.nimbusds.oauth2.sdk.SAML2BearerGrant

@Immutable
public class SAML2BearerGrant
extends AssertionGrant

SAML 2.0 bearer grant. Used in access token requests with a SAML 2.0 bearer assertion.

Related specifications:

• SAML 2.0 Profile for OAuth 2.0 Client Authentication and Authorization Grants (draft-ietf-oauth-saml2-bearer-21), 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
SAML2BearerGrant(com.nimbusds.jose.util.Base64URL assertion) Creates a new SAML 2.0 bearer assertion grant.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAssertion() Gets the assertion.
com.nimbusds.jose.util.Base64URL	getSAML2Assertion() Gets the SAML 2.0 bearer assertion.
static SAML2BearerGrant	parse(Map<String,String> params) Parses a SAML 2.0 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

SAML2BearerGrant

public SAML2BearerGrant(com.nimbusds.jose.util.Base64URL assertion)

Creates a new SAML 2.0 bearer assertion grant.

Parameters:

assertion - The SAML 2.0 bearer assertion. Must not be null.

Method Detail

getSAML2Assertion

public com.nimbusds.jose.util.Base64URL getSAML2Assertion()

Gets the SAML 2.0 bearer assertion.

Returns:

The SAML 2.0 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 SAML2BearerGrant parse(Map<String,String> params)
                              throws ParseException

Parses a SAML 2.0 bearer grant from the specified parameters.

Example:

 grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Asaml2-
 bearer&assertion=PEFzc2VydGlvbiBJc3N1ZUluc3RhbnQ9IjIwMTEtMDU
 [...omitted for brevity...]aG5TdGF0ZW1lbnQ-PC9Bc3NlcnRpb24-
 

Parameters:

params - The parameters.

Returns:

The SAML 2.0 bearer grant.

Throws:

ParseException - If parsing failed.