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

Interface PasswordGrantHandler

All Superinterfaces:

Lifecycle

public interface PasswordGrantHandler
extends Lifecycle

Service Provider Interface (SPI) for handling token requests with a Resource Owner Password Credentials grant.

Related specifications:

• OAuth 2.0 (RFC 6749), sections 1.3.3 and 4.3.

Method Summary

Methods

Modifier and Type	Method and Description
PasswordGrantAuthorization	processGrant(com.nimbusds.oauth2.sdk.ResourceOwnerPasswordCredentialsGrant grant, com.nimbusds.oauth2.sdk.Scope scope, com.nimbusds.oauth2.sdk.id.ClientID clientID, boolean confidentialClient, com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata clientMetadata) Handles a Resource Owner Password Credentials grant request.

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

init, isEnabled, shutdown

Method Detail

processGrant

PasswordGrantAuthorization processGrant(com.nimbusds.oauth2.sdk.ResourceOwnerPasswordCredentialsGrant grant,
                                      com.nimbusds.oauth2.sdk.Scope scope,
                                      com.nimbusds.oauth2.sdk.id.ClientID clientID,
                                      boolean confidentialClient,
                                      com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata clientMetadata)
                                        throws com.nimbusds.oauth2.sdk.GeneralException

Handles a Resource Owner Password Credentials grant request.

Parameters:

grant - The Resource Owner Password Credentials grant. Not null.

scope - The requested scope, null if not specified.

clientID - The client identifier. Not null.

confidentialClient - true if the client is confidential and has been authenticated, else false.

clientMetadata - The client metadata. Not null.

Returns:

The password grant authorisation response.

Throws:

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