Package org.keycloak.services.clientregistration.policy

Interface ClientRegistrationPolicy

All Superinterfaces:

org.keycloak.provider.Provider

All Known Implementing Classes:

ClientDisabledClientRegistrationPolicy, ClientScopesClientRegistrationPolicy, ConsentRequiredClientRegistrationPolicy, MaxClientsClientRegistrationPolicy, ProtocolMappersClientRegistrationPolicy, RegistrationWebOriginsPolicy, ScopeClientRegistrationPolicy, TrustedHostClientRegistrationPolicy

public interface ClientRegistrationPolicy
extends org.keycloak.provider.Provider

Author:

Marek Posolda

Method Summary

Modifier and Type	Method	Description
void	afterRegister(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	afterUpdate(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	beforeDelete(ClientRegistrationProvider provider, org.keycloak.models.ClientModel clientModel)
void	beforeRegister(ClientRegistrationContext context)
void	beforeUpdate(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	beforeView(ClientRegistrationProvider provider, org.keycloak.models.ClientModel clientModel)
default void	close()
default Collection<String>	getAllowedOrigins()	Extra web origins this policy contributes to the CORS allow-list for responses produced by the client registration endpoints.

Method Details

beforeRegister

void beforeRegister(ClientRegistrationContext context)
             throws ClientRegistrationPolicyException

Throws:

ClientRegistrationPolicyException

afterRegister

void afterRegister(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)

beforeUpdate

void beforeUpdate(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)
           throws ClientRegistrationPolicyException

Throws:

ClientRegistrationPolicyException

afterUpdate

void afterUpdate(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)

beforeView

void beforeView(ClientRegistrationProvider provider,
 org.keycloak.models.ClientModel clientModel)
         throws ClientRegistrationPolicyException

Throws:

ClientRegistrationPolicyException

beforeDelete

void beforeDelete(ClientRegistrationProvider provider,
 org.keycloak.models.ClientModel clientModel)
           throws ClientRegistrationPolicyException

Throws:

ClientRegistrationPolicyException

getAllowedOrigins

default Collection<String> getAllowedOrigins()

Extra web origins this policy contributes to the CORS allow-list for responses produced by the client registration endpoints. Origins are collected up-front so validation can happen in a single checkAllowedOrigins call before the handler runs.

close

default void close()

Specified by:

close in interface org.keycloak.provider.Provider