com.nimbusds.openid.connect.provider.spi.grants

Interface ClientCredentialsGrantHandler

All Superinterfaces:

GrantHandler, Lifecycle

public interface ClientCredentialsGrantHandler
extends GrantHandler

Service Provider Interface (SPI) for handling token requests with an OAuth 2.0 Client Credentials grant.

Related specifications:

• OAuth 2.0 (RFC 6749), sections 1.3.4 and 4.4.

Method Summary

Methods

Modifier and Type	Method and Description
GrantAuthorization	processGrant(com.nimbusds.oauth2.sdk.Scope scope, com.nimbusds.oauth2.sdk.id.ClientID clientID, com.nimbusds.oauth2.sdk.client.ClientMetadata clientMetadata) Handles a Client Credentials grant request.

Methods inherited from interface com.nimbusds.openid.connect.provider.spi.grants.GrantHandler

getGrantType

Methods inherited from interface com.nimbusds.openid.connect.provider.spi.Lifecycle

init, isEnabled, shutdown

Method Detail

processGrant

GrantAuthorization processGrant(com.nimbusds.oauth2.sdk.Scope scope,
                              com.nimbusds.oauth2.sdk.id.ClientID clientID,
                              com.nimbusds.oauth2.sdk.client.ClientMetadata clientMetadata)
                                throws com.nimbusds.oauth2.sdk.GeneralException

Handles a Client Credentials grant request. The client is confidential and always authenticated.

Parameters:

scope - The requested scope, null if not specified.

clientID - The client identifier. Not null.

clientMetadata - The OAuth 2.0 client metadata. Not null.

Returns:

The client credentials grant authorisation response.

Throws:

com.nimbusds.oauth2.sdk.GeneralException - If the grant is denied, or another exception was encountered.