io.apiman.manager.api.rest.contract

Interface IUserResource

@Path(value="users")
public interface IUserResource

The User API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.idm.UserBean	get(String userId) Use this endpoint to get information about a specific user by the User ID.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean>	getActivity(String userId, int page, int pageSize) Use this endpoint to get information about the user's audit history.
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplications(String userId) This endpoint returns all applications that the user has permission to edit.
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getOrganizations(String userId) This endpoint returns the list of organizations that the user is a member of.
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServices(String userId) This endpoint returns all services that the user has permission to edit.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.UserBean>	search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Use this endpoint to search for users.
void	update(String userId, io.apiman.manager.api.beans.idm.UpdateUserBean user) Use this endpoint to update the information about a user.

Method Detail

get

@GET
@Path(value="{userId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.UserBean get(@PathParam(value="userId")
                                                             String userId)
                                             throws UserNotFoundException

Use this endpoint to get information about a specific user by the User ID.

Parameters:

userId - The user ID.

Returns:

Full user information.

Throws:

UserNotFoundException - when specified user not found

update

@PUT
@Path(value="{userId}")
@Consumes(value="application/json")
void update(@PathParam(value="userId")
                            String userId,
                            io.apiman.manager.api.beans.idm.UpdateUserBean user)
            throws UserNotFoundException,
                   NotAuthorizedException

Use this endpoint to update the information about a user. This will fail unless the authenticated user is an admin or identical to the user being updated.

Parameters:

userId - The user ID.

user - Updated user information.

Throws:

UserNotFoundException - when specified user not found

NotAuthorizedException - when not authorized to invoke this method

search

@POST
@Path(value="search")
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.UserBean> search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                      throws InvalidSearchCriteriaException

Use this endpoint to search for users. The search criteria is provided in the body of the request, including filters, order-by, and paging information.

Parameters:

criteria - The search criteria.

Returns:

The search results (a page of organizations).

Throws:

InvalidSearchCriteriaException - when provided criteria are invalid

getOrganizations

@GET
@Path(value="{userId}/organizations")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getOrganizations(@PathParam(value="userId")
                                                                                                   String userId)

This endpoint returns the list of organizations that the user is a member of. The user is a member of an organization if she has at least one role for the org.

Parameters:

userId - The user ID.

Returns:

List of organizations.

getApplications

@GET
@Path(value="{userId}/applications")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> getApplications(@PathParam(value="userId")
                                                                                                 String userId)

This endpoint returns all applications that the user has permission to edit.

Parameters:

userId - The user ID.

Returns:

List of applications.

getServices

@GET
@Path(value="{userId}/services")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean> getServices(@PathParam(value="userId")
                                                                                         String userId)

This endpoint returns all services that the user has permission to edit.

Parameters:

userId - The user ID.

Returns:

List of services.

getActivity

@GET
@Path(value="{userId}/activity")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.audit.AuditEntryBean> getActivity(@PathParam(value="userId")
                                                                                                                                   String userId,
                                                                                                                                   @QueryParam(value="page")
                                                                                                                                   int page,
                                                                                                                                   @QueryParam(value="count")
                                                                                                                                   int pageSize)

Use this endpoint to get information about the user's audit history. This returns audit entries corresponding to each of the actions taken by the user. For example, when a user creates a new Organization, an audit entry is recorded and would be included in the result of this endpoint.

Parameters:

userId - The user ID.

page - The page of the results to return.

pageSize - The number of results per page to return.

Returns:

List of audit entries.