Package org.keycloak.services.resources.admin

Class ClientScopeEvaluateResource

java.lang.Object

org.keycloak.services.resources.admin.ClientScopeEvaluateResource

public class ClientScopeEvaluateResource
extends Object

Author:

Marek Posolda

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientScopeEvaluateResource.ProtocolMapperEvaluationRepresentation

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.jboss.logging.Logger	logger

Constructor Summary

Constructors

Constructor	Description
ClientScopeEvaluateResource(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, AdminPermissionEvaluator auth, ClientModel client, ClientConnection clientConnection)

Method Summary

Modifier and Type	Method	Description
org.keycloak.representations.AccessToken	generateExampleAccessToken(String scopeParam, String userId, String audience)	Create JSON with payload of example access token
org.keycloak.representations.IDToken	generateExampleIdToken(String scopeParam, String userId, String audience)	Create JSON with payload of example id token
Map<String,Object>	generateExampleUserinfo(String scopeParam, String userId)	Create JSON with payload of example user info
Stream<ClientScopeEvaluateResource.ProtocolMapperEvaluationRepresentation>	getGrantedProtocolMappers(String scopeParam)	Return list of all protocol mappers, which will be used when generating tokens issued for particular client.
ClientScopeEvaluateScopeMappingsResource	scopeMappings(String scopeParam, String roleContainerId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.jboss.logging.Logger logger

Constructor Details

ClientScopeEvaluateResource

public ClientScopeEvaluateResource(KeycloakSession session,
 jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm,
 AdminPermissionEvaluator auth,
 ClientModel client,
 ClientConnection clientConnection)

Method Details

scopeMappings

@Path("scope-mappings/{roleContainerId}")
public ClientScopeEvaluateScopeMappingsResource scopeMappings(@QueryParam("scope")
 String scopeParam,
 @PathParam("roleContainerId")
 String roleContainerId)

Parameters:

scopeParam -

roleContainerId - either realm name OR client UUID

Returns:

getGrantedProtocolMappers

@GET
@Path("protocol-mappers")
@Produces("application/json")
public Stream<ClientScopeEvaluateResource.ProtocolMapperEvaluationRepresentation> getGrantedProtocolMappers(@QueryParam("scope")
 String scopeParam)

Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.

Returns:

generateExampleUserinfo

@GET
@Path("generate-example-userinfo")
@Produces("application/json")
public Map<String,Object> generateExampleUserinfo(@QueryParam("scope")
 String scopeParam,
 @QueryParam("userId")
 String userId)

Create JSON with payload of example user info

Returns:

generateExampleIdToken

@GET
@Path("generate-example-id-token")
@Produces("application/json")
public org.keycloak.representations.IDToken generateExampleIdToken(@QueryParam("scope")
 String scopeParam,
 @QueryParam("userId")
 String userId,
 @QueryParam("audience")
 String audience)

Create JSON with payload of example id token

Returns:

generateExampleAccessToken

@GET
@Path("generate-example-access-token")
@Produces("application/json")
public org.keycloak.representations.AccessToken generateExampleAccessToken(@QueryParam("scope")
 String scopeParam,
 @QueryParam("userId")
 String userId,
 @QueryParam("audience")
 String audience)

Create JSON with payload of example access token

Returns: