org.apache.nifi.web.security.oidc

Interface OidcIdentityProvider

All Known Implementing Classes:

StandardOidcIdentityProvider

public interface OidcIdentityProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPEN_ID_CONNECT_SUPPORT_IS_NOT_CONFIGURED

Method Summary

Modifier and Type	Method and Description
String	exchangeAuthorizationCodeForAccessToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant) Exchanges the supplied authorization grant for an Access Token.
String	exchangeAuthorizationCodeForIdToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant) Exchanges the supplied authorization grant for an ID Token.
LoginAuthenticationToken	exchangeAuthorizationCodeforLoginAuthenticationToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant) Exchanges the supplied authorization grant for a Login ID Token.
URI	getAuthorizationEndpoint() Returns the URI for the authorization endpoint.
com.nimbusds.oauth2.sdk.id.ClientID	getClientId() Returns the configured client id.
URI	getEndSessionEndpoint() Returns the URI for the end session endpoint.
URI	getRevocationEndpoint() Returns the URI for the revocation endpoint.
com.nimbusds.oauth2.sdk.Scope	getScope() Returns the scopes supported by the OIDC provider.
void	initializeProvider() Initializes the provider.
boolean	isOidcEnabled() Returns whether OIDC support is enabled.

Field Detail

OPEN_ID_CONNECT_SUPPORT_IS_NOT_CONFIGURED

static final String OPEN_ID_CONNECT_SUPPORT_IS_NOT_CONFIGURED

See Also:

Constant Field Values

Method Detail

initializeProvider

void initializeProvider()

Initializes the provider.

isOidcEnabled

boolean isOidcEnabled()

Returns whether OIDC support is enabled.

Returns:

whether OIDC support is enabled

getClientId

com.nimbusds.oauth2.sdk.id.ClientID getClientId()

Returns the configured client id.

Returns:

the client id

getAuthorizationEndpoint

URI getAuthorizationEndpoint()

Returns the URI for the authorization endpoint.

Returns:

uri for the authorization endpoint

getEndSessionEndpoint

URI getEndSessionEndpoint()

Returns the URI for the end session endpoint.

Returns:

uri for the end session endpoint

getRevocationEndpoint

URI getRevocationEndpoint()

Returns the URI for the revocation endpoint.

Returns:

uri for the revocation endpoint

getScope

com.nimbusds.oauth2.sdk.Scope getScope()

Returns the scopes supported by the OIDC provider.

Returns:

support scopes

exchangeAuthorizationCodeforLoginAuthenticationToken

LoginAuthenticationToken exchangeAuthorizationCodeforLoginAuthenticationToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant)
                                                                       throws IOException

Exchanges the supplied authorization grant for a Login ID Token. Extracts the identity from the ID token.

Parameters:

authorizationGrant - authorization grant for invoking the Token Endpoint

Returns:

a Login Authentication Token

Throws:

IOException - if there was an exceptional error while communicating with the OIDC provider

exchangeAuthorizationCodeForAccessToken

String exchangeAuthorizationCodeForAccessToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant)
                                        throws Exception

Exchanges the supplied authorization grant for an Access Token.

Parameters:

authorizationGrant - authorization grant for invoking the Token Endpoint

Returns:

an Access Token String

Throws:

Exception - if there was an exceptional error while communicating with the OIDC provider

exchangeAuthorizationCodeForIdToken

String exchangeAuthorizationCodeForIdToken(com.nimbusds.oauth2.sdk.AuthorizationGrant authorizationGrant)
                                    throws IOException

Exchanges the supplied authorization grant for an ID Token.

Parameters:

authorizationGrant - authorization grant for invoking the Token Endpoint

Returns:

an ID Token String

Throws:

IOException - if there was an exceptional error while communicating with the OIDC provider