Package com.symphony.api.pod

Interface AppEntitlementApi

@Path("/")
public interface AppEntitlementApi

Pod API

This document refers to Symphony API calls that do not need encryption or decryption of content. - sessionToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have made no change to the system even if ome subset of the request would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X.

Method Summary

Modifier and Type	Method	Description
PodAppEntitlementList	v1AdminAppEntitlementListGet(String sessionToken)	Get the list of application entitlements for the company
PodAppEntitlementList	v1AdminAppEntitlementListPost(List<PodAppEntitlement> body, String sessionToken)	Update the application entitlements for the company
UserAppEntitlementList	v1AdminUserUidAppEntitlementListGet(String sessionToken, Long uid)	Get the list of application entitlements for this user
UserAppEntitlementList	v1AdminUserUidAppEntitlementListPost(List<UserAppEntitlement> body, String sessionToken, Long uid)	Update the application entitlements for this user

Method Detail

v1AdminAppEntitlementListGet

@GET
@Path("/v1/admin/app/entitlement/list")
@Produces("application/json")
PodAppEntitlementList v1AdminAppEntitlementListGet(@HeaderParam("sessionToken")
                                                   String sessionToken)

Get the list of application entitlements for the company

v1AdminAppEntitlementListPost

@POST
@Path("/v1/admin/app/entitlement/list")
@Consumes("application/json")
@Produces("application/json")
PodAppEntitlementList v1AdminAppEntitlementListPost(List<PodAppEntitlement> body,
                                                    @HeaderParam("sessionToken")
                                                    String sessionToken)

Update the application entitlements for the company

v1AdminUserUidAppEntitlementListGet

@GET
@Path("/v1/admin/user/{uid}/app/entitlement/list")
@Produces("application/json")
UserAppEntitlementList v1AdminUserUidAppEntitlementListGet(@HeaderParam("sessionToken")
                                                           String sessionToken,
                                                           @PathParam("uid")
                                                           Long uid)

Get the list of application entitlements for this user

v1AdminUserUidAppEntitlementListPost

@POST
@Path("/v1/admin/user/{uid}/app/entitlement/list")
@Consumes("application/json")
@Produces("application/json")
UserAppEntitlementList v1AdminUserUidAppEntitlementListPost(List<UserAppEntitlement> body,
                                                            @HeaderParam("sessionToken")
                                                            String sessionToken,
                                                            @PathParam("uid")
                                                            Long uid)

Update the application entitlements for this user