io.apiman.manager.api.rest.contract

Interface ICurrentUserResource

@Path(value="currentuser")
public interface ICurrentUserResource

The Current User API. Returns information about the authenticated user.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
List<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	getApplications() Use this endpoint to list all of the Applications the current user has permission to edit.
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getAppOrganizations() This endpoint returns a list of all the organizations for which the current user has permission to edit applications.
io.apiman.manager.api.beans.idm.CurrentUserBean	getInfo() Use this endpoint to get information about the currently authenticated user.
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getPlanOrganizations() This endpoint returns a list of all the organizations for which the current user has permission to edit plans.
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	getServiceOrganizations() This endpoint returns a list of all the organizations for which the current user has permission to edit services.
List<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	getServices() Use this endpoint to list all of the Services the current user has permission to edit.
void	updateInfo(io.apiman.manager.api.beans.idm.UpdateUserBean info) This endpoint allows updating information about the authenticated user.

Method Detail

getInfo

@GET
@Path(value="info")
@Produces(value="application/json")
io.apiman.manager.api.beans.idm.CurrentUserBean getInfo()

Use this endpoint to get information about the currently authenticated user.

Returns:

Information about the authenticated user.

updateInfo

@PUT
@Path(value="info")
@Consumes(value="application/json")
void updateInfo(io.apiman.manager.api.beans.idm.UpdateUserBean info)

This endpoint allows updating information about the authenticated user.

Parameters:

info - Data to use when updating the user.

getAppOrganizations

@GET
@Path(value="apporgs")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getAppOrganizations()

This endpoint returns a list of all the organizations for which the current user has permission to edit applications. For example, when creating a new Application, the user interface must ask the user to choose within which Organization to create it. This endpoint lists the valid choices for the current user.

Returns:

A list of organizations.

getServiceOrganizations

@GET
@Path(value="svcorgs")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getServiceOrganizations()

This endpoint returns a list of all the organizations for which the current user has permission to edit services. For example, when creating a new Service, the user interface must ask the user to choose within which Organization to create it. This endpoint lists the valid choices for the current user.

Returns:

A list of organizations.

getPlanOrganizations

@GET
@Path(value="planorgs")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> getPlanOrganizations()

This endpoint returns a list of all the organizations for which the current user has permission to edit plans. For example, when creating a new Plan, the user interface must ask the user to choose within which Organization to create it. This endpoint lists the valid choices for the current user.

Returns:

A list of organizations.

getApplications

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

Use this endpoint to list all of the Applications the current user has permission to edit. This includes all Applications from all Organizations the user has application edit privileges for.

Returns:

A list of Applications.

getServices

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

Use this endpoint to list all of the Services the current user has permission to edit. This includes all Services from all Organizations the user has service edit privileges for.

Returns:

A list of Services.