keycloak
|
公開メンバ関数 | |
void | addFederatedIdentity (RealmModel realm, UserModel user, FederatedIdentityModel socialLink) |
boolean | removeFederatedIdentity (RealmModel realm, UserModel user, String socialProvider) |
void | updateFederatedIdentity (RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel) |
Set< FederatedIdentityModel > | getFederatedIdentities (UserModel user, RealmModel realm) |
FederatedIdentityModel | getFederatedIdentity (UserModel user, String socialProvider, RealmModel realm) |
UserModel | getUserByFederatedIdentity (FederatedIdentityModel socialLink, RealmModel realm) |
void | addConsent (RealmModel realm, String userId, UserConsentModel consent) |
UserConsentModel | getConsentByClient (RealmModel realm, String userId, String clientInternalId) |
List< UserConsentModel > | getConsents (RealmModel realm, String userId) |
void | updateConsent (RealmModel realm, String userId, UserConsentModel consent) |
boolean | revokeConsentForClient (RealmModel realm, String userId, String clientInternalId) |
void | setNotBeforeForUser (RealmModel realm, UserModel user, int notBefore) |
int | getNotBeforeOfUser (RealmModel realm, UserModel user) |
UserModel | getServiceAccount (ClientModel client) |
List< UserModel > | getUsers (RealmModel realm, boolean includeServiceAccounts) |
List< UserModel > | getUsers (RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts) |
UserModel | addUser (RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) |
void | preRemove (RealmModel realm) |
void | removeImportedUsers (RealmModel realm, String storageProviderId) |
void | unlinkUsers (RealmModel realm, String storageProviderId) |
void | preRemove (RealmModel realm, RoleModel role) |
void | preRemove (RealmModel realm, GroupModel group) |
void | preRemove (RealmModel realm, ClientModel client) |
void | preRemove (ProtocolMapperModel protocolMapper) |
void | preRemove (ClientScopeModel clientScope) |
void | close () |
void | preRemove (RealmModel realm, ComponentModel component) |
UserModel | getUserById (String id, RealmModel realm) |
UserModel | getUserByUsername (String username, RealmModel realm) |
UserModel | getUserByEmail (String email, RealmModel realm) |
int | getUsersCount (RealmModel realm) |
default int | getUsersCount (RealmModel realm, boolean includeServiceAccount) |
List< UserModel > | getUsers (RealmModel realm) |
List< UserModel > | getUsers (RealmModel realm, int firstResult, int maxResults) |
List< UserModel > | searchForUser (String search, RealmModel realm) |
List< UserModel > | searchForUser (String search, RealmModel realm, int firstResult, int maxResults) |
List< UserModel > | searchForUser (Map< String, String > params, RealmModel realm) |
List< UserModel > | searchForUser (Map< String, String > params, RealmModel realm, int firstResult, int maxResults) |
List< UserModel > | getGroupMembers (RealmModel realm, GroupModel group, int firstResult, int maxResults) |
List< UserModel > | getGroupMembers (RealmModel realm, GroupModel group) |
default List< UserModel > | getRoleMembers (RealmModel realm, RoleModel role) |
default List< UserModel > | getRoleMembers (RealmModel realm, RoleModel role, int firstResult, int maxResults) |
List< UserModel > | searchForUserByUserAttribute (String attrName, String attrValue, RealmModel realm) |
UserModel | addUser (RealmModel realm, String username) |
boolean | removeUser (RealmModel realm, UserModel user) |
void | grantToAllUsers (RealmModel realm, RoleModel role) |
void org.keycloak.models.UserProvider.addConsent | ( | RealmModel | realm, |
String | userId, | ||
UserConsentModel | consent | ||
) |
void org.keycloak.models.UserProvider.addFederatedIdentity | ( | RealmModel | realm, |
UserModel | user, | ||
FederatedIdentityModel | socialLink | ||
) |
|
inherited |
All storage providers that implement this interface will be looped through. If this method returns null, then the next storage provider's addUser() method will be called. If no storage providers handle the add, then the user will be created in local storage.
Returning null is useful when you want optional support for adding users. For example, our LDAP provider can enable and disable the ability to add users.
realm | |
username |
org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.ldap.LDAPStorageProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.jpa.JpaUserProviderで実装されています。
UserModel org.keycloak.models.UserProvider.addUser | ( | RealmModel | realm, |
String | id, | ||
String | username, | ||
boolean | addDefaultRoles, | ||
boolean | addDefaultRequiredActions | ||
) |
only used for local storage
realm | |
id | |
username | |
addDefaultRoles | |
addDefaultRequiredActions |
org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.models.jpa.JpaUserProviderで実装されています。
void org.keycloak.models.UserProvider.close | ( | ) |
UserConsentModel org.keycloak.models.UserProvider.getConsentByClient | ( | RealmModel | realm, |
String | userId, | ||
String | clientInternalId | ||
) |
List<UserConsentModel> org.keycloak.models.UserProvider.getConsents | ( | RealmModel | realm, |
String | userId | ||
) |
Set<FederatedIdentityModel> org.keycloak.models.UserProvider.getFederatedIdentities | ( | UserModel | user, |
RealmModel | realm | ||
) |
FederatedIdentityModel org.keycloak.models.UserProvider.getFederatedIdentity | ( | UserModel | user, |
String | socialProvider, | ||
RealmModel | realm | ||
) |
|
inherited |
Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.
realm | |
group | |
firstResult | |
maxResults |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inherited |
Get users that belong to a specific group. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.
realm | |
group |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
int org.keycloak.models.UserProvider.getNotBeforeOfUser | ( | RealmModel | realm, |
UserModel | user | ||
) |
|
inlineinherited |
Get users that belong to a specific role.
realm | |
role |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManagerで実装されています。
|
inlineinherited |
Search for users that have a specific role with a specific roleId.
firstResult | |
maxResults | |
role |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.cache.infinispan.UserCacheSessionで実装されています。
UserModel org.keycloak.models.UserProvider.getServiceAccount | ( | ClientModel | client | ) |
|
inherited |
UserModel org.keycloak.models.UserProvider.getUserByFederatedIdentity | ( | FederatedIdentityModel | socialLink, |
RealmModel | realm | ||
) |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
List<UserModel> org.keycloak.models.UserProvider.getUsers | ( | RealmModel | realm, |
boolean | includeServiceAccounts | ||
) |
List<UserModel> org.keycloak.models.UserProvider.getUsers | ( | RealmModel | realm, |
int | firstResult, | ||
int | maxResults, | ||
boolean | includeServiceAccounts | ||
) |
|
inherited |
Returns the number of users, without consider any service account.
realm | the realm |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inlineinherited |
Returns the number of users.
realm | the realm |
includeServiceAccount | if true, the number of users will also include service accounts. Otherwise, only the number of users. |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManagerで実装されています。
|
inherited |
void org.keycloak.models.UserProvider.preRemove | ( | RealmModel | realm | ) |
void org.keycloak.models.UserProvider.preRemove | ( | RealmModel | realm, |
RoleModel | role | ||
) |
void org.keycloak.models.UserProvider.preRemove | ( | RealmModel | realm, |
GroupModel | group | ||
) |
void org.keycloak.models.UserProvider.preRemove | ( | RealmModel | realm, |
ClientModel | client | ||
) |
void org.keycloak.models.UserProvider.preRemove | ( | ProtocolMapperModel | protocolMapper | ) |
void org.keycloak.models.UserProvider.preRemove | ( | ClientScopeModel | clientScope | ) |
void org.keycloak.models.UserProvider.preRemove | ( | RealmModel | realm, |
ComponentModel | component | ||
) |
boolean org.keycloak.models.UserProvider.removeFederatedIdentity | ( | RealmModel | realm, |
UserModel | user, | ||
String | socialProvider | ||
) |
void org.keycloak.models.UserProvider.removeImportedUsers | ( | RealmModel | realm, |
String | storageProviderId | ||
) |
Removes any imported users from a specific User Storage Provider.
realm | |
storageProviderId |
org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.models.jpa.JpaUserProviderで実装されています。
|
inherited |
Called if user originated from this provider.
If a local user is linked to this provider, this method will be called before local storage's removeUser() method is invoked.
If you are using an import strategy, and this is a local user linked to this provider, this method will be called before local storage's removeUser() method is invoked. Also, you DO NOT need to remove the imported user. The runtime will handle this for you.
realm | |
user |
org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.ldap.LDAPStorageProvider, org.keycloak.storage.UserStorageManager, org.keycloak.models.jpa.JpaUserProviderで実装されています。
boolean org.keycloak.models.UserProvider.revokeConsentForClient | ( | RealmModel | realm, |
String | userId, | ||
String | clientInternalId | ||
) |
|
inherited |
Search for users with username, email or first + last name that is like search string.
If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.
This method is used by the admin console search box
search | |
realm |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inherited |
Search for users with username, email or first + last name that is like search string.
If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.
This method is used by the admin console search box
search | |
realm | |
firstResult | |
maxResults |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inherited |
Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username
If possible, implementations should treat the parameter values as partial match patterns i.e. in RDMBS terms use LIKE.
This method is used by the REST API when querying users.
params | |
realm |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inherited |
Search for user by parameter. Valid parameters are: "first" - first name "last" - last name "email" - email "username" - username
If possible, implementations should treat the parameter values as patterns i.e. in RDMBS terms use LIKE. This method is used by the REST API when querying users.
params | |
realm | |
firstResult | |
maxResults |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
|
inherited |
Search for users that have a specific attribute with a specific value. Implementations do not have to search in UserFederatedStorageProvider as this is done automatically.
attrName | |
attrValue | |
realm |
org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.storage.ldap.LDAPStorageProviderで実装されています。
void org.keycloak.models.UserProvider.setNotBeforeForUser | ( | RealmModel | realm, |
UserModel | user, | ||
int | notBefore | ||
) |
void org.keycloak.models.UserProvider.unlinkUsers | ( | RealmModel | realm, |
String | storageProviderId | ||
) |
Set federation link to null to imported users of a specific User Storage Provider
realm | |
storageProviderId |
org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.storage.UserStorageManager, org.keycloak.models.jpa.JpaUserProviderで実装されています。
void org.keycloak.models.UserProvider.updateConsent | ( | RealmModel | realm, |
String | userId, | ||
UserConsentModel | consent | ||
) |
void org.keycloak.models.UserProvider.updateFederatedIdentity | ( | RealmModel | realm, |
UserModel | federatedUser, | ||
FederatedIdentityModel | federatedIdentityModel | ||
) |