Package org.keycloak.protocol.oidc.grants.ciba.endpoints

Class CibaRootEndpoint

java.lang.Object

org.keycloak.protocol.oidc.grants.ciba.endpoints.CibaRootEndpoint

All Implemented Interfaces:

OIDCExtProvider, OIDCExtProviderFactory, EnvironmentDependentProviderFactory, Provider, ProviderFactory<OIDCExtProvider>

public class CibaRootEndpoint
extends Object
implements OIDCExtProvider, OIDCExtProviderFactory, EnvironmentDependentProviderFactory

Author:

Pedro Igor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Constructor Summary

Constructors

Constructor	Description
CibaRootEndpoint()
CibaRootEndpoint(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
BackchannelAuthenticationCallbackEndpoint	authenticate()	The callback endpoint used by authentication devices to notify Keycloak about the end-user authentication status.
BackchannelAuthenticationEndpoint	authorize()	The backchannel authentication endpoint used by consumption devices to obtain authorization from end-users.
void	close()	This is called when the server shuts down.
OIDCExtProvider	create(KeycloakSession session)
String	getId()
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	setEvent(EventBuilder event)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.protocol.oidc.ext.OIDCExtProviderFactory

init, order, postInit

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

CibaRootEndpoint

public CibaRootEndpoint()

CibaRootEndpoint

public CibaRootEndpoint(KeycloakSession session)

Method Details

authorize

@Path("/auth")
public BackchannelAuthenticationEndpoint authorize()

The backchannel authentication endpoint used by consumption devices to obtain authorization from end-users.

Returns:

authenticate

@Path("/auth/callback")
public BackchannelAuthenticationCallbackEndpoint authenticate()

The callback endpoint used by authentication devices to notify Keycloak about the end-user authentication status.

Returns:

create

public OIDCExtProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<OIDCExtProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<OIDCExtProvider>

setEvent

public void setEvent(EventBuilder event)

Specified by:

setEvent in interface OIDCExtProvider

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface OIDCExtProvider

Specified by:

close in interface OIDCExtProviderFactory

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<OIDCExtProvider>

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.