org.keycloak.storage.federated

Interface UserRoleMappingsFederatedStorage

All Known Subinterfaces:

UserFederatedStorageProvider, UserFederatedStorageProvider.Streams, UserRoleMappingsFederatedStorage.Streams

public interface UserRoleMappingsFederatedStorage

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserRoleMappingsFederatedStorage.Streams The UserRoleMappingsFederatedStorage.Streams interface makes all collection-based methods in UserRoleMappingsFederatedStorage default by providing implementations that delegate to the Stream-based variants instead of the other way around.

Method Summary

Modifier and Type	Method and Description
void	deleteRoleMapping(RealmModel realm, String userId, RoleModel role)
Set<RoleModel>	getRoleMappings(RealmModel realm, String userId) Deprecated. Use getRoleMappingsStream instead.
default Stream<RoleModel>	getRoleMappingsStream(RealmModel realm, String userId) Obtains the roles associated with the federated user identified by userId.
void	grantRole(RealmModel realm, String userId, RoleModel role)

Method Detail

getRoleMappings

@Deprecated
Set<RoleModel> getRoleMappings(RealmModel realm,
                                           String userId)

Deprecated. Use getRoleMappingsStream instead.

grantRole

void grantRole(RealmModel realm,
               String userId,
               RoleModel role)

getRoleMappingsStream

default Stream<RoleModel> getRoleMappingsStream(RealmModel realm,
                                                String userId)

Obtains the roles associated with the federated user identified by userId.

Parameters:

realm - a reference to the realm.

userId - the user identifier.

Returns:

a non-null Stream of roles.

deleteRoleMapping

void deleteRoleMapping(RealmModel realm,
                       String userId,
                       RoleModel role)