Package com.broadleafcommerce.auth.user.web.endpoint

Class UserAccessController

java.lang.Object

com.broadleafcommerce.auth.user.web.endpoint.UserAccessController

@FrameworkRestController
@FrameworkMapping("/user-operations")
public class UserAccessController
extends Object

Endpoint for retrieving information about the currently authenticated user

Author:

Nick Crum (ncrum), Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
UserAccessController(UserOperationService userOperationService)

Method Summary

Modifier and Type	Method	Description
UserOperationInformation	findUserOperationsByScope(Set<String> scopes)	This operation is covered under the 'authentication' security filter chain and only works under session-based authentication.
UserOperationInformation	findUserOperationsByScope(Set<String> scopes, String accountId)	This operation is covered under the 'authentication' security filter chain and only works under session-based authentication.
UserOperationInformation	resourceApiFindUserOperationsByScope(Set<String> scopes, String clientId)	This operation is covered under the 'resource' security filter chain and only works under bearer-token authentication.
UserOperationInformation	resourceApiFindUserOperationsByScope(Set<String> scopes, String clientId, String accountId)	This operation is covered under the 'resource' security filter chain and only works under bearer-token authentication.

Methods inherited from class java.lang.Object

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

Constructor Details

UserAccessController

public UserAccessController(UserOperationService userOperationService)

Method Details

findUserOperationsByScope

@FrameworkGetMapping
public UserOperationInformation findUserOperationsByScope(@RequestParam("scope")
 Set<String> scopes)

This operation is covered under the 'authentication' security filter chain and only works under session-based authentication.

Parameters:

scopes - the scopes to get user operation information for

Returns:

details about accessibility

findUserOperationsByScope

@FrameworkGetMapping(params="accountId")
public UserOperationInformation findUserOperationsByScope(@RequestParam("scope")
 Set<String> scopes,
 @RequestParam
 String accountId)

This operation is covered under the 'authentication' security filter chain and only works under session-based authentication.

Parameters:

scopes - the scopes to get user operation information for

accountId - the account to base accessibility checks on

Returns:

details about accessibility

resourceApiFindUserOperationsByScope

@FrameworkGetMapping(path="/resource")
public UserOperationInformation resourceApiFindUserOperationsByScope(@RequestParam("scope")
 Set<String> scopes,
 @RequestParam("client_id")
 String clientId)

This operation is covered under the 'resource' security filter chain and only works under bearer-token authentication. There are no specific scopes/permissions required in that Bearer token in order to execute this operation - if the token passes basic validation it will be used to identify the user and return their operation information.

Parameters:

scopes - the scopes to get user operation information for

clientId - the authorized client ID (should match the client under which the current user is registered)

Returns:

details about accessibility

resourceApiFindUserOperationsByScope

@FrameworkGetMapping(path="/resource",
                     params="accountId")
public UserOperationInformation resourceApiFindUserOperationsByScope(@RequestParam("scope")
 Set<String> scopes,
 @RequestParam("client_id")
 String clientId,
 @RequestParam
 String accountId)

This operation is covered under the 'resource' security filter chain and only works under bearer-token authentication. There are no specific scopes/permissions required in that Bearer token in order to execute this operation - if the token passes basic validation it will be used to identify the user and return their operation information.

Parameters:

scopes - the scopes to get user operation information for

clientId - the authorized client ID (should match the client under which the current user is registered)

accountId - the account to base accessibility checks on

Returns:

details about accessibility