Package io.camunda.identity.sdk.impl.keycloak

Class KeycloakAuthentication

java.lang.Object

io.camunda.identity.sdk.authentication.AbstractAuthentication

io.camunda.identity.sdk.impl.generic.GenericAuthentication

io.camunda.identity.sdk.impl.keycloak.KeycloakAuthentication

All Implemented Interfaces:

Authentication

public class KeycloakAuthentication
extends GenericAuthentication

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZE_PATH
static final String	JWKS_PATH
static final String	LOGOUT_PATH
static final String	TOKEN_PATH

Fields inherited from class io.camunda.identity.sdk.impl.generic.GenericAuthentication

jwkProvider

Fields inherited from class io.camunda.identity.sdk.authentication.AbstractAuthentication

configuration, JWKS_CACHE_LIFETIME_DAYS, JWKS_CACHE_SIZE, restClient, tokenCache, WELL_KNOWN_PATH

Constructor Summary

Constructors

Constructor	Description
KeycloakAuthentication(IdentityConfiguration configuration, RestClient restClient)

Method Summary

Modifier and Type	Method	Description
AuthorizeUriBuilder	authorizeUriBuilder(String redirectUri)	Returns a new Authorize uri builder.
Tokens	exchangeAuthCode(AuthCodeDto authCodeDto, String redirectUri)	Exchanges provided auth code with access tokens.
String	getClientId(String token)	Gets the client ID associated to the token
protected List<String>	getGroupsInOrganization(com.auth0.jwt.interfaces.DecodedJWT token, String organizationId)
List<String>	getPermissions(com.auth0.jwt.interfaces.DecodedJWT token, String audience)
boolean	isM2MToken(String token)	Checks if the token passed in is considered an M2M token.
protected com.auth0.jwk.JwkProvider	jwkProvider()
Tokens	renewToken(String refreshToken)	Exchanges provided refresh token with an access tokens.
protected Tokens	requestFreshToken(String audience)
void	revokeToken(String refreshToken)	Logs out from Identity backend.

Methods inherited from class io.camunda.identity.sdk.impl.generic.GenericAuthentication

fromAccessTokenDto, getAssignedOrganizations, isRevokeAvailable, isSingleSignOutAvailable, wellKnownConfiguration

Methods inherited from class io.camunda.identity.sdk.authentication.AbstractAuthentication

decodeJWT, generateSingleSignOutUri, getGroups, getGroups, getGroupsInOrganization, getGroupsInOrganization, getPermissions, getPermissions, getUserDetails, isAvailable, requestToken, singleSignOut, singleSignOutUriBuilder, verifyAndDecode, verifyToken, verifyToken, verifyToken, verifyTokenIgnoringAudience

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AUTHORIZE_PATH

public static final String AUTHORIZE_PATH

See Also:

• Constant Field Values

TOKEN_PATH

public static final String TOKEN_PATH

See Also:

• Constant Field Values

LOGOUT_PATH

public static final String LOGOUT_PATH

See Also:

• Constant Field Values

JWKS_PATH

public static final String JWKS_PATH

See Also:

• Constant Field Values

Constructor Details

KeycloakAuthentication

public KeycloakAuthentication(IdentityConfiguration configuration,
 RestClient restClient)

Method Details

authorizeUriBuilder

public AuthorizeUriBuilder authorizeUriBuilder(String redirectUri)

Description copied from interface: Authentication

Returns a new Authorize uri builder. It is used to build the authorize uri for user authentication.

Specified by:

authorizeUriBuilder in interface Authentication

Overrides:

authorizeUriBuilder in class GenericAuthentication

Parameters:

redirectUri - the redirect uri

Returns:

the authorize uri builder

exchangeAuthCode

public Tokens exchangeAuthCode(AuthCodeDto authCodeDto,
 String redirectUri)
                        throws CodeExchangeException

Description copied from interface: Authentication

Exchanges provided auth code with access tokens. The provided redirect uri argument must match the redirect uri that was used to build the authorize uri.

Specified by:

exchangeAuthCode in interface Authentication

Overrides:

exchangeAuthCode in class GenericAuthentication

Parameters:

authCodeDto - the auth code dto

redirectUri - the redirect uri

Returns:

the tokens

Throws:

CodeExchangeException - if code exchange fails

requestFreshToken

protected Tokens requestFreshToken(String audience)

Overrides:

requestFreshToken in class GenericAuthentication

renewToken

public Tokens renewToken(String refreshToken)

Description copied from interface: Authentication

Exchanges provided refresh token with an access tokens.

Specified by:

renewToken in interface Authentication

Overrides:

renewToken in class GenericAuthentication

Parameters:

refreshToken - refresh token used for the request

Returns:

the tokens

revokeToken

public void revokeToken(String refreshToken)

Description copied from interface: Authentication

Logs out from Identity backend. This will invalidate the given refresh token and refresh tokens issued for other applications during the same session. The user's session or access token still has to be deleted by the client application.

Specified by:

revokeToken in interface Authentication

Overrides:

revokeToken in class GenericAuthentication

Parameters:

refreshToken - refresh token used for the request

getPermissions

public List<String> getPermissions(com.auth0.jwt.interfaces.DecodedJWT token,
 String audience)

Overrides:

getPermissions in class GenericAuthentication

getGroupsInOrganization

protected List<String> getGroupsInOrganization(com.auth0.jwt.interfaces.DecodedJWT token,
 String organizationId)

Overrides:

getGroupsInOrganization in class AbstractAuthentication

isM2MToken

public boolean isM2MToken(String token)

Description copied from interface: Authentication

Checks if the token passed in is considered an M2M token.

Specified by:

isM2MToken in interface Authentication

Overrides:

isM2MToken in class GenericAuthentication

Parameters:

token - the token

Returns:

true if the token is a M2M token, else false

getClientId

public String getClientId(String token)

Description copied from interface: Authentication

Gets the client ID associated to the token

Specified by:

getClientId in interface Authentication

Overrides:

getClientId in class GenericAuthentication

Parameters:

token - the token

Returns:

the clientID

jwkProvider

protected com.auth0.jwk.JwkProvider jwkProvider()

Overrides:

jwkProvider in class GenericAuthentication