org.keycloak.models.UserModel の継承関係図

org.keycloak.models.UserModel 連携図

クラス
enum	RequiredAction

interface	UserRemovedEvent

公開メンバ関数
String	getId ()

String	getUsername ()

void	setUsername (String username)

Long	getCreatedTimestamp ()

void	setCreatedTimestamp (Long timestamp)

boolean	isEnabled ()

void	setEnabled (boolean enabled)

void	setSingleAttribute (String name, String value)

void	setAttribute (String name, List< String > values)

void	removeAttribute (String name)

String	getFirstAttribute (String name)

List< String >	getAttribute (String name)

Map< String, List< String > >	getAttributes ()

Set< String >	getRequiredActions ()

void	addRequiredAction (String action)

void	removeRequiredAction (String action)

void	addRequiredAction (RequiredAction action)

void	removeRequiredAction (RequiredAction action)

String	getFirstName ()

void	setFirstName (String firstName)

String	getLastName ()

void	setLastName (String lastName)

String	getEmail ()

void	setEmail (String email)

boolean	isEmailVerified ()

void	setEmailVerified (boolean verified)

Set< GroupModel >	getGroups ()

void	joinGroup (GroupModel group)

void	leaveGroup (GroupModel group)

boolean	isMemberOf (GroupModel group)

String	getFederationLink ()

void	setFederationLink (String link)

String	getServiceAccountClientLink ()

void	setServiceAccountClientLink (String clientInternalId)

Set< RoleModel >	getRealmRoleMappings ()

Set< RoleModel >	getClientRoleMappings (ClientModel app)

boolean	hasRole (RoleModel role)

void	grantRole (RoleModel role)

Set< RoleModel >	getRoleMappings ()

void	deleteRoleMapping (RoleModel role)

公開変数類
String	USERNAME = "username"

String	LAST_NAME = "lastName"

String	FIRST_NAME = "firstName"

String	EMAIL = "email"

String	LOCALE = "locale"

詳解

著者: Bill Burke

バージョン

Revision: 1

クラス詳解

◆ org::keycloak::models::UserModel::RequiredAction

enum org::keycloak::models::UserModel::RequiredAction

org.keycloak.models.UserModel.RequiredAction 連携図

列挙値
CONFIGURE_TOTP
TERMS_AND_CONDITIONS
UPDATE_PASSWORD
UPDATE_PROFILE
VERIFY_EMAIL

関数詳解

◆ addRequiredAction() [1/2]

void org.keycloak.models.UserModel.addRequiredAction ( String action )

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.ReadOnlyUserModelDelegateで実装されています。

◆ addRequiredAction() [2/2]

void org.keycloak.models.UserModel.addRequiredAction ( RequiredAction action )

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.ReadOnlyUserModelDelegateで実装されています。

◆ deleteRoleMapping()

void org.keycloak.models.RoleMapperModel.deleteRoleMapping ( RoleModel role )

inherited

Removes the given role mapping from this object.

引数

role	Role to remove

org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.models.utils.ReadOnlyUserModelDelegateで実装されています。

◆ getAttribute()

List<String> org.keycloak.models.UserModel.getAttribute ( String name )

引数

name

戻り値: list of all attribute values or empty list if there are not any values. Never return null

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getAttributes()

Map<String, List<String> > org.keycloak.models.UserModel.getAttributes ( )

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getClientRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getClientRoleMappings ( ClientModel app )

inherited

Returns set of client roles that are directly set to this object for the given client.

引数

app	Client to get the roles for

戻り値: see description

org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.jpa.GroupAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.utils.UserModelDelegate, org.keycloak.models.cache.infinispan.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ getCreatedTimestamp()

Long org.keycloak.models.UserModel.getCreatedTimestamp ( )

Get timestamp of user creation. May be null for old users created before this feature introduction.

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.UserAdapterで実装されています。

◆ getEmail()

String org.keycloak.models.UserModel.getEmail ( )

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getFederationLink()

String org.keycloak.models.UserModel.getFederationLink ( )

org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getFirstAttribute()

String org.keycloak.models.UserModel.getFirstAttribute ( String name )

引数

name

戻り値: null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getFirstName()

String org.keycloak.models.UserModel.getFirstName ( )

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getGroups()

Set<GroupModel> org.keycloak.models.UserModel.getGroups ( )

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ getId()

String org.keycloak.models.UserModel.getId ( )

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getLastName()

String org.keycloak.models.UserModel.getLastName ( )

org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getRealmRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getRealmRoleMappings ( )

inherited

Returns set of realm roles that are directly set to this object.

戻り値: see description

org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.GroupAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ getRequiredActions()

Set<String> org.keycloak.models.UserModel.getRequiredActions ( )

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper.MSADUserModelDelegate, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.storage.adapter.AbstractUserAdapterで実装されています。

◆ getRoleMappings()

Set<RoleModel> org.keycloak.models.RoleMapperModel.getRoleMappings ( )

inherited

Returns set of all role (both realm all client) that are directly set to this object.

戻り値

org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getServiceAccountClientLink()

String org.keycloak.models.UserModel.getServiceAccountClientLink ( )

org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ getUsername()

String org.keycloak.models.UserModel.getUsername ( )

org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.UserAdapter, org.keycloak.models.utils.UserModelDelegateで実装されています。

◆ grantRole()

void org.keycloak.models.RoleMapperModel.grantRole ( RoleModel role )

inherited

Grants the given role to this object.

引数

role

org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate, org.keycloak.models.jpa.UserAdapter, org.keycloak.storage.adapter.InMemoryUserAdapter, org.keycloak.models.cache.infinispan.UserAdapter, org.keycloak.models.jpa.GroupAdapter, org.keycloak.storage.adapter.AbstractUserAdapterFederatedStorage, org.keycloak.models.cache.infinispan.GroupAdapter, org.keycloak.models.utils.UserModelDelegate, org.keycloak.storage.adapter.AbstractUserAdapter, org.keycloak.models.utils.ReadOnlyUserModelDelegateで実装されています。

◆ hasRole()

boolean org.keycloak.models.RoleMapperModel.hasRole ( RoleModel role )

inherited

Returns

true

if this object is directly or indirectly assigned the given role,

false

otherwise.

For example,

true

is returned for hasRole(R) if:

R is directly assigned to this object
R is not assigned to this object but this object belongs to a group G which is assigned the role R
R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R

引数

role