Class ScopeMappedClientResource
java.lang.Object
org.keycloak.services.resources.admin.ScopeMappedClientResource
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Modifier and TypeFieldDescriptionprotected AdminEventBuilder
protected AdminPermissionEvaluator
protected RealmModel
protected ScopeContainerModel
protected ClientModel
protected KeycloakSession
-
Constructor Summary
ConstructorDescriptionScopeMappedClientResource
(RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, ClientModel scopedClient, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add client-level roles to the client's scopevoid
Remove client-level roles from the client's scope.The available client-level roles Returns the roles for the client that can be associated with the client's scopeGet the roles associated with a client's scope Returns roles for the client.getCompositeClientScopeMappings
(boolean briefRepresentation) Get effective client roles Returns the roles for the client that are associated with the client's scope.
-
Field Details
-
realm
-
auth
-
managePermission
-
viewPermission
-
scopeContainer
-
session
-
scopedClient
-
adminEvent
-
-
Constructor Details
-
ScopeMappedClientResource
public ScopeMappedClientResource(RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, ClientModel scopedClient, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission)
-
-
Method Details
-
getClientScopeMappings
Get the roles associated with a client's scope Returns roles for the client.- Returns:
-
getAvailableClientScopeMappings
@Path("available") @GET @Produces("application/json") public Stream<RoleRepresentation> getAvailableClientScopeMappings()The available client-level roles Returns the roles for the client that can be associated with the client's scope- Returns:
-
getCompositeClientScopeMappings
@Path("composite") @GET @Produces("application/json") public Stream<RoleRepresentation> getCompositeClientScopeMappings(@QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation) Get effective client roles Returns the roles for the client that are associated with the client's scope.- Parameters:
briefRepresentation
- if false, return roles with their attributes- Returns:
-
addClientScopeMapping
@POST @Consumes("application/json") public void addClientScopeMapping(List<RoleRepresentation> roles) Add client-level roles to the client's scope- Parameters:
roles
-
-
deleteClientScopeMapping
@DELETE @Consumes("application/json") public void deleteClientScopeMapping(List<RoleRepresentation> roles) Remove client-level roles from the client's scope.- Parameters:
roles
-
-