Package org.keycloak.services.managers

Class ApplianceBootstrap

java.lang.Object

org.keycloak.services.managers.ApplianceBootstrap

public class ApplianceBootstrap
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Constructor Summary

Constructors

Constructor	Description
ApplianceBootstrap(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
boolean	createMasterRealm()
boolean	createMasterRealmAdminUser(String username, String password, boolean isTemporary, boolean initialUser)	Create a temporary admin user
boolean	createMasterRealmAdminUser(String username, String password, String firstName, String lastName, String email, boolean isTemporary, boolean initialUser)	Create a temporary admin user with additional profile information
void	createMasterRealmUser(String username, String password, boolean isTemporary)
void	createMasterRealmUser(String username, String password, String firstName, String lastName, String email, boolean isTemporary)
boolean	createTemporaryMasterRealmAdminService(String clientId, String clientSecret)	Create a temporary admin service account
boolean	isNewInstall()
boolean	isNoMasterUser()

Methods inherited from class java.lang.Object

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

Constructor Details

ApplianceBootstrap

public ApplianceBootstrap(KeycloakSession session)

Method Details

isNewInstall

public boolean isNewInstall()

isNoMasterUser

public boolean isNoMasterUser()

createMasterRealm

public boolean createMasterRealm()

createMasterRealmAdminUser

public boolean createMasterRealmAdminUser(String username,
 String password,
 boolean isTemporary,
 boolean initialUser)

Create a temporary admin user

Parameters:

username - the admin username

password - the admin password

isTemporary - whether the user is a temporary admin

initialUser - if true only create the user if no other users exist

Returns:

false if the user could not be created

createMasterRealmAdminUser

public boolean createMasterRealmAdminUser(String username,
 String password,
 String firstName,
 String lastName,
 String email,
 boolean isTemporary,
 boolean initialUser)

Create a temporary admin user with additional profile information

Parameters:

username - the admin username

password - the admin password

firstName - the admin user's first name (optional)

lastName - the admin user's last name (optional)

email - the admin user's email address (optional)

isTemporary - whether the user is a temporary admin

initialUser - if true only create the user if no other users exist

Returns:

false if the user could not be created

createTemporaryMasterRealmAdminService

public boolean createTemporaryMasterRealmAdminService(String clientId,
 String clientSecret)

Create a temporary admin service account

Parameters:

clientId - the client ID

clientSecret - the client secret

Returns:

false if the service account could not be created

createMasterRealmUser

public void createMasterRealmUser(String username,
 String password,
 boolean isTemporary)

createMasterRealmUser

public void createMasterRealmUser(String username,
 String password,
 String firstName,
 String lastName,
 String email,
 boolean isTemporary)