io.apiman.manager.api.rest.contract

Interface IPermissionsResource

@Path(value="permissions")
public interface IPermissionsResource

The Permissions API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.idm.UserPermissionsBean	getPermissionsForCurrentUser() This endpoint returns all of the permissions assigned to the currently authenticated user.
io.apiman.manager.api.beans.idm.UserPermissionsBean	getPermissionsForUser(String userId) This endpoint returns all of the permissions assigned to a specific user.

Method Detail

getPermissionsForUser

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

This endpoint returns all of the permissions assigned to a specific user.

Parameters:

userId - The user's ID.

Returns:

All of the user's permissions.

Throws:

UserNotFoundException - when a request is sent for a user who does not exist

NotAuthorizedException - when the user is not authorized to perform this action

getPermissionsForCurrentUser

@GET
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.UserPermissionsBean getPermissionsForCurrentUser()
                                                                                 throws UserNotFoundException

This endpoint returns all of the permissions assigned to the currently authenticated user.

Returns:

All of the user's permissions.

Throws:

UserNotFoundException - when a request is sent for a user who does not exist