Package org.keycloak.admin.client.resource

Interface ClientScopeEvaluateResource

public interface ClientScopeEvaluateResource

Author:

Giuseppe Graziano

Method Summary

Modifier and Type	Method	Description
AccessToken	generateAccessToken(String scopeParam, String userId, String audience)	Generate example access token
IDToken	generateExampleIdToken(String scopeParam, String userId, String audience)	Generate example ID token
Map<String,Object>	generateExampleUserinfo(String scopeParam, String userId)	Generate example user-info response

Method Details

generateAccessToken

@GET
@Path("generate-example-access-token")
AccessToken generateAccessToken(@QueryParam("scope")
 String scopeParam,
 @QueryParam("userId")
 String userId,
 @QueryParam("audience")
 String audience)

Generate example access token

Parameters:

scopeParam - Value of the "scope" parameter. Endpoint simulates generating of the access-token as if the "scope" parameter with specified value is used. Could be null.

userId - User ID

audience - Value of the "audience" parameter. Endpoint simulates generating of the access-token as if the "audience" parameter with specified value is used. Audience parameter is supported just for some grants (EG. for the token exchange). For most of the grants where "audience" parameter is not supported, it is better to use the value null to simulate generating of the appropriate token. Parameter is supported since Keycloak 26.2.

Returns:

generated access token

generateExampleIdToken

@GET
@Path("generate-example-id-token")
IDToken generateExampleIdToken(@QueryParam("scope")
 String scopeParam,
 @QueryParam("userId")
 String userId,
 @QueryParam("audience")
 String audience)

Generate example ID token

Parameters:

scopeParam - Value of the "scope" parameter. Endpoint simulates generating of the ID-token as if the "scope" parameter with specified value is used. Could be null.

userId - User ID

audience - Value of the "audience" parameter. Endpoint simulates generating of the access-token as if the "audience" parameter with specified value is used. Audience parameter is supported just for some grants (EG. for the token exchange). For most of the grants where "audience" parameter is not supported, it is better to use the value null to simulate generating of the appropriate token. Parameter is supported since Keycloak 26.2.

Returns:

generated ID token

generateExampleUserinfo

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

Generate example user-info response

Parameters:

scopeParam - Value of the "scope" parameter. Endpoint simulates generating of the user-info as if the "scope" parameter with specified value is used for generating the access-token, which would then be used for the user-info request. Could be null.

userId - User ID

Returns:

generated user-info