Package 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	Description
static interface	UserRoleMappingsFederatedStorage.Streams	Deprecated. This interface is no longer necessary; collection-based methods were removed from the parent interface and therefore the parent interface can be used directly

Method Summary

Modifier and Type	Method	Description
void	deleteRoleMapping(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.RoleModel role)
Stream<org.keycloak.models.RoleModel>	getRoleMappingsStream(org.keycloak.models.RealmModel realm, String userId)	Obtains the roles associated with the federated user identified by userId.
Stream<String>	getRoleMembersStream(org.keycloak.models.RealmModel realm, org.keycloak.models.RoleModel role, Integer firstResult, Integer max)	Obtains the federated users that are members of the given role in the specified realm.
void	grantRole(org.keycloak.models.RealmModel realm, String userId, org.keycloak.models.RoleModel role)

Method Details

grantRole

void grantRole(org.keycloak.models.RealmModel realm,
 String userId,
 org.keycloak.models.RoleModel role)

getRoleMappingsStream

Stream<org.keycloak.models.RoleModel> getRoleMappingsStream(org.keycloak.models.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(org.keycloak.models.RealmModel realm,
 String userId,
 org.keycloak.models.RoleModel role)

getRoleMembersStream

Stream<String> getRoleMembersStream(org.keycloak.models.RealmModel realm,
 org.keycloak.models.RoleModel role,
 Integer firstResult,
 Integer max)

Obtains the federated users that are members of the given role in the specified realm.

Parameters:

realm - a reference to the realm.

role - a reference to the role whose federated members are being searched.

firstResult - first result to return. Ignored if negative or null.

max - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of federated user ids that are members of the role in the realm.