io.apiman.manager.api.rest.contract

Interface IRoleResource

@Path(value="roles")
public interface IRoleResource

The Role API. Used to manage roles. Note: not used to manage users or user membership in roles. This API simply provides a way to create and manage role definitions. Typically this API is only available to system admins.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.idm.RoleBean	create(io.apiman.manager.api.beans.idm.NewRoleBean bean) Use this endpoint to create a new apiman role.
void	delete(String roleId) Use this endpoint to delete a role by its ID.
io.apiman.manager.api.beans.idm.RoleBean	get(String roleId) Use this endpoint to retrieve information about a single Role by its ID.
List<io.apiman.manager.api.beans.idm.RoleBean>	list() This endpoint lists all of the roles currently defined in apiman.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean>	search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) This endpoint provides a way to search for roles.
void	update(String roleId, io.apiman.manager.api.beans.idm.UpdateRoleBean bean) Use this endpoint to update the information about an existing role.

Method Detail

create

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.RoleBean create(io.apiman.manager.api.beans.idm.NewRoleBean bean)
                                                throws RoleAlreadyExistsException,
                                                       NotAuthorizedException

Use this endpoint to create a new apiman role. A role consists of a set of permissions granted to a user when that user is given the role within the context of an organization.

Parameters:

bean - The new role.

Returns:

Full information about the created role.

Throws:

RoleAlreadyExistsException - when role already exists

NotAuthorizedException - when not authorized to invoke this method

list

@GET
@Produces(value="application/json")
List<io.apiman.manager.api.beans.idm.RoleBean> list()
                                                    throws NotAuthorizedException

This endpoint lists all of the roles currently defined in apiman.

Returns:

A list of roles.

Throws:

NotAuthorizedException - when not authorized to invoke this method

get

@GET
@Path(value="{roleId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.RoleBean get(@PathParam(value="roleId")
                                                             String roleId)
                                             throws RoleNotFoundException,
                                                    NotAuthorizedException

Use this endpoint to retrieve information about a single Role by its ID.

Parameters:

roleId - The role ID.

Returns:

A role.

Throws:

RoleNotFoundException - when a request is sent for a role that does not exist

NotAuthorizedException - when not authorized to invoke this method

update

@PUT
@Path(value="{roleId}")
@Consumes(value="application/json")
void update(@PathParam(value="roleId")
                            String roleId,
                            io.apiman.manager.api.beans.idm.UpdateRoleBean bean)
            throws RoleNotFoundException,
                   NotAuthorizedException

Use this endpoint to update the information about an existing role. The role is identified by its ID.

Parameters:

roleId - The role ID.

bean - Updated role information.

Throws:

RoleNotFoundException - when a request is sent for a role that does not exist

NotAuthorizedException - when not authorized to invoke this method

delete

@DELETE
@Path(value="{roleId}")
void delete(@PathParam(value="roleId")
                      String roleId)
            throws RoleNotFoundException,
                   NotAuthorizedException

Use this endpoint to delete a role by its ID.

Parameters:

roleId - The role ID.

Throws:

RoleNotFoundException - when a request is sent for a role that does not exist

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.RoleBean> search(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                      throws InvalidSearchCriteriaException,
                                                                                                             NotAuthorizedException

This endpoint provides a way to search for roles. 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 roles).

Throws:

InvalidSearchCriteriaException - when provided criteria are invalid

NotAuthorizedException - when not authorized to invoke this method