org.keycloak.services.resources.admin

Class AuthenticationManagementResource

java.lang.Object

org.keycloak.services.resources.admin.AuthenticationManagementResource

public class AuthenticationManagementResource
extends Object

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationManagementResource.AuthenticationExecutionRepresentation
class	AuthenticationManagementResource.AuthenticatorConfigDescription
static class	AuthenticationManagementResource.RequiredActionProviderRepresentation

Constructor Summary

Constructors

Constructor and Description
AuthenticationManagementResource(RealmModel realm, KeycloakSession session, RealmAuth auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addExecution(AuthenticationExecutionModel model) Add new authentication execution
void	addExecution(String flowAlias, Map<String,String> data) Add new authentication execution to a flow
void	addExecutionFlow(String flowAlias, Map<String,String> data) Add new flow with new execution to existing flow
List<Map<String,Object>>	buildProviderMetadata(List<ProviderFactory> factories)
protected void	copy(String newName, AuthenticationFlowModel from, AuthenticationFlowModel to)
javax.ws.rs.core.Response	copy(String flowAlias, Map<String,String> data) Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object
javax.ws.rs.core.Response	createAuthenticatorConfig(AuthenticatorConfigModel config) Create new authenticator configuration
javax.ws.rs.core.Response	createFlow(AuthenticationFlowModel model) Create a new authentication flow
void	deleteFlow(String id) Delete an authentication flow
AuthenticatorConfigModel	getAuthenticatorConfig(String id) Get authenticator configuration
AuthenticatorConfigModel	getAuthenticatorConfig(String execution, String id) Get execution's configuration
AuthenticationManagementResource.AuthenticatorConfigDescription	getAuthenticatorConfigDescription(String providerId) Get authenticator provider's configuration description
List<Map<String,Object>>	getAuthenticatorProviders() Get authenticator providers Returns a list of authenticator providers.
List<Map<String,Object>>	getClientAuthenticatorProviders() Get client authenticator providers Returns a list of client authenticator providers.
javax.ws.rs.core.Response	getExecutions(String flowAlias) Get authentication executions for a flow
AuthenticationFlowModel	getFlow(String id) Get authentication flow for id
List<AuthenticationFlowModel>	getFlows() Get authentication flows Returns a list of authentication flows.
List<Map<String,Object>>	getFormActionProviders() Get form action providers Returns a list of form action providers.
List<Map<String,Object>>	getFormProviders() Get form providers Returns a list of form providers.
AuthenticationFlowModel	getParentFlow(AuthenticationExecutionModel model)
Map<String,List<ConfigPropertyRepresentation>>	getPerClientConfigDescription() Get configuration descriptions for all clients
AuthenticationManagementResource.RequiredActionProviderRepresentation	getRequiredAction(String alias) Get required action for alias
List<AuthenticationManagementResource.RequiredActionProviderRepresentation>	getRequiredActions() Get required actions Returns a list of required actions.
List<AuthenticationExecutionModel>	getSortedExecutions(AuthenticationFlowModel parentFlow)
List<Map<String,String>>	getUnregisteredRequiredActions() Get unregistered required actions Returns a list of unregistered required actions.
void	lowerPriority(String execution) Lower execution's priority
javax.ws.rs.core.Response	newExecutionConfig(String execution, AuthenticatorConfigModel config) Update execution with new configuration
void	raisePriority(String execution) Raise execution's priority
void	recurseExecutions(AuthenticationFlowModel flow, List<AuthenticationManagementResource.AuthenticationExecutionRepresentation> result, int level)
void	registereRequiredAction(Map<String,String> data) Register a new required actions
void	removeAuthenticatorConfig(String id) Delete authenticator configuration
void	removeExecution(String execution) Delete execution
static AuthenticationManagementResource.RequiredActionProviderRepresentation	toRepresentation(RequiredActionProviderModel model)
void	updateAuthenticatorConfig(String id, AuthenticatorConfigModel config) Update authenticator configuration
void	updateExecutions(String flowAlias, AuthenticationManagementResource.AuthenticationExecutionRepresentation rep) Update authentication executions of a flow
void	updateRequiredAction(String alias) Delete required action
void	updateRequiredAction(String alias, AuthenticationManagementResource.RequiredActionProviderRepresentation rep) Update required action

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationManagementResource

public AuthenticationManagementResource(RealmModel realm,
                                        KeycloakSession session,
                                        RealmAuth auth,
                                        AdminEventBuilder adminEvent)

Method Detail

getFormProviders

public List<Map<String,Object>> getFormProviders()

Get form providers Returns a list of form providers.

getAuthenticatorProviders

public List<Map<String,Object>> getAuthenticatorProviders()

Get authenticator providers Returns a list of authenticator providers.

getClientAuthenticatorProviders

public List<Map<String,Object>> getClientAuthenticatorProviders()

Get client authenticator providers Returns a list of client authenticator providers.

buildProviderMetadata

public List<Map<String,Object>> buildProviderMetadata(List<ProviderFactory> factories)

getFormActionProviders

public List<Map<String,Object>> getFormActionProviders()

Get form action providers Returns a list of form action providers.

getFlows

public List<AuthenticationFlowModel> getFlows()

Get authentication flows Returns a list of authentication flows.

createFlow

public javax.ws.rs.core.Response createFlow(AuthenticationFlowModel model)

Create a new authentication flow

Parameters:

model - Authentication flow model

Returns:

getFlow

public AuthenticationFlowModel getFlow(String id)

Get authentication flow for id

Parameters:

id - Flow id

Returns:

deleteFlow

public void deleteFlow(String id)

Delete an authentication flow

Parameters:

id - Flow id

copy

public javax.ws.rs.core.Response copy(String flowAlias,
                                      Map<String,String> data)

Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object

Parameters:

flowAlias - Name of the existing authentication flow

data - JSON containing 'newName' attribute

copy

protected void copy(String newName,
                    AuthenticationFlowModel from,
                    AuthenticationFlowModel to)

addExecutionFlow

public void addExecutionFlow(String flowAlias,
                             Map<String,String> data)

Add new flow with new execution to existing flow

Parameters:

flowAlias - Alias of parent authentication flow

data - New authentication flow / execution JSON data containing 'alias', 'type', 'provider', and 'description' attributes

addExecution

public void addExecution(String flowAlias,
                         Map<String,String> data)

Add new authentication execution to a flow

Parameters:

flowAlias - Alias of parent flow

data - New execution JSON data containing 'provider' attribute

getExecutions

public javax.ws.rs.core.Response getExecutions(String flowAlias)

Get authentication executions for a flow

Parameters:

flowAlias - Flow alias

recurseExecutions

public void recurseExecutions(AuthenticationFlowModel flow,
                              List<AuthenticationManagementResource.AuthenticationExecutionRepresentation> result,
                              int level)

updateExecutions

public void updateExecutions(String flowAlias,
                             AuthenticationManagementResource.AuthenticationExecutionRepresentation rep)

Update authentication executions of a flow

Parameters:

flowAlias - Flow alias

rep -

addExecution

public javax.ws.rs.core.Response addExecution(AuthenticationExecutionModel model)

Add new authentication execution

Parameters:

model - JSON model describing authentication execution

getParentFlow

public AuthenticationFlowModel getParentFlow(AuthenticationExecutionModel model)

raisePriority

public void raisePriority(String execution)

Raise execution's priority

Parameters:

execution - Execution id

getSortedExecutions

public List<AuthenticationExecutionModel> getSortedExecutions(AuthenticationFlowModel parentFlow)

lowerPriority

public void lowerPriority(String execution)

Lower execution's priority

Parameters:

execution - Execution id

removeExecution

public void removeExecution(String execution)

Delete execution

Parameters:

execution - Execution id

newExecutionConfig

public javax.ws.rs.core.Response newExecutionConfig(String execution,
                                                    AuthenticatorConfigModel config)

Update execution with new configuration

Parameters:

execution - Execution id

config - JSON with new configuration

Returns:

getAuthenticatorConfig

public AuthenticatorConfigModel getAuthenticatorConfig(String execution,
                                                       String id)

Get execution's configuration

Parameters:

execution - Execution id

id - Configuration id

getUnregisteredRequiredActions

public List<Map<String,String>> getUnregisteredRequiredActions()

Get unregistered required actions Returns a list of unregistered required actions.

registereRequiredAction

public void registereRequiredAction(Map<String,String> data)

Register a new required actions

Parameters:

data - JSON containing 'providerId', and 'name' attributes.

getRequiredActions

public List<AuthenticationManagementResource.RequiredActionProviderRepresentation> getRequiredActions()

Get required actions Returns a list of required actions.

toRepresentation

public static AuthenticationManagementResource.RequiredActionProviderRepresentation toRepresentation(RequiredActionProviderModel model)

getRequiredAction

public AuthenticationManagementResource.RequiredActionProviderRepresentation getRequiredAction(String alias)

Get required action for alias

Parameters:

alias - Alias of required action

updateRequiredAction

public void updateRequiredAction(String alias,
                                 AuthenticationManagementResource.RequiredActionProviderRepresentation rep)

Update required action

Parameters:

alias - Alias of required action

rep - JSON describing new state of required action

updateRequiredAction

public void updateRequiredAction(String alias)

Delete required action

Parameters:

alias - Alias of required action

getAuthenticatorConfigDescription

public AuthenticationManagementResource.AuthenticatorConfigDescription getAuthenticatorConfigDescription(String providerId)

Get authenticator provider's configuration description

getPerClientConfigDescription

public Map<String,List<ConfigPropertyRepresentation>> getPerClientConfigDescription()

Get configuration descriptions for all clients

createAuthenticatorConfig

public javax.ws.rs.core.Response createAuthenticatorConfig(AuthenticatorConfigModel config)

Create new authenticator configuration

Parameters:

config - JSON describing new authenticator configuration

getAuthenticatorConfig

public AuthenticatorConfigModel getAuthenticatorConfig(String id)

Get authenticator configuration

Parameters:

id - Configuration id

removeAuthenticatorConfig

public void removeAuthenticatorConfig(String id)

Delete authenticator configuration

Parameters:

id - Configuration id

updateAuthenticatorConfig

public void updateAuthenticatorConfig(String id,
                                      AuthenticatorConfigModel config)

Update authenticator configuration

Parameters:

id - Configuration id

config - JSON describing new state of authenticator configuration