com.nimbusds.oauth2.sdk

Class ClientCredentialsGrant

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationGrant

com.nimbusds.oauth2.sdk.ClientCredentialsGrant

@Immutable
public class ClientCredentialsGrant
extends AuthorizationGrant

Client credentials grant. Used in access token requests with a client's identifier and secret. This class is immutable.

Related specifications:

• OAuth 2.0 (RFC 6749), section 4.4.2.

Author:

Vladimir Dzhuvinov

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsGrant(Scope scope) Creates a new client credentials grant.

Method Summary

Methods

Modifier and Type	Method and Description
Scope	getScope() Gets the requested scope.
static ClientCredentialsGrant	parse(Map<String,String> params) Parses a client credentials 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 associated grant type.

Constructor Detail

ClientCredentialsGrant

public ClientCredentialsGrant(Scope scope)

Creates a new client credentials grant.

Parameters:

scope - The requested scope, null if not specified.

Method Detail

getScope

public Scope getScope()

Gets the requested scope.

Returns:

The requested scope, null if not specified.

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 ClientCredentialsGrant parse(Map<String,String> params)
                                    throws ParseException

Parses a client credentials grant from the specified parameters.

Example:

 grant_type=client_credentials
 

Parameters:

params - The parameters.

Returns:

The client credentials grant.

Throws:

ParseException - If parsing failed.