```
@Path("/")
public interface UserApi
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UserDetail`	`v1AdminUserCreatePost(UserCreate body, String sessionToken)`	Create a new user
`UserDetailList`	`v1AdminUserFindPost(UserFilter body, String sessionToken, Integer skip, Integer limit)`	Find a user based on attributes
`UserIdList`	`v1AdminUserListGet(String sessionToken)`	Retreive a list of all users in the company (pod)
`AvatarList`	`v1AdminUserUidAvatarGet(String sessionToken, Long uid)`	Get the URL of the avatar of a particular user
`SuccessResponse`	`v1AdminUserUidAvatarUpdatePost(AvatarUpdate body, String sessionToken, Long uid)`	Update the avatar of a particular user
`IntegerList`	`v1AdminUserUidDelegatesGet(String sessionToken, Long uid)`	Get the delegates assigned to a user
`SuccessResponse`	`v1AdminUserUidDelegatesUpdatePost(DelegateAction body, String sessionToken, Long uid)`	Update the delegates assigned to a user
`SuccessResponse`	`v1AdminUserUidDisclaimerDelete(String sessionToken, Long uid)`	Unassign a disclaimer from a user
`Disclaimer`	`v1AdminUserUidDisclaimerGet(String sessionToken, Long uid)`	Get the disclaimer assigned to a user
`SuccessResponse`	`v1AdminUserUidDisclaimerUpdatePost(StringId body, String sessionToken, Long uid)`	Assign a disclaimer to a user
`FeatureList`	`v1AdminUserUidFeaturesGet(String sessionToken, Long uid)`	Get the list of Symphony feature entitlements enabled for a particular user
`SuccessResponse`	`v1AdminUserUidFeaturesUpdatePost(List<Feature> body, String sessionToken, Long uid)`	Update the list of Symphony feature entitlements for a particular user
`UserDetail`	`v1AdminUserUidGet(String sessionToken, Long uid)`	Retreive user details for a particular user
`SuccessResponse`	`v1AdminUserUidRolesAddPost(StringId body, String sessionToken, Long uid)`	Add a role to a user
`SuccessResponse`	`v1AdminUserUidRolesRemovePost(StringId body, String sessionToken, Long uid)`	Remove a role from a user
`UserStatus`	`v1AdminUserUidStatusGet(String sessionToken, Long uid)`	Get the status, active or inactive, for a particular user
`SuccessResponse`	`v1AdminUserUidStatusUpdatePost(UserStatus body, String sessionToken, Long uid)`	Update the status of a particular user
`UserDetail`	`v1AdminUserUidUpdatePost(UserAttributes body, String sessionToken, Long uid)`	Update an existing user
`V2UserDetail`	`v2AdminUserCreatePost(V2UserCreate body, String sessionToken)`	Create a new V2 User
`V2UserDetailList`	`v2AdminUserListGet(String sessionToken, Integer skip, Integer limit)`	Retrieve a list of all users in the company (pod)
`V2UserDetail`	`v2AdminUserUidGet(String sessionToken, Long uid)`	Retreive V2 User details for a particular user
`V2UserDetail`	`v2AdminUserUidUpdatePost(V2UserAttributes body, String sessionToken, Long uid)`	Update an existing V2 User

Method Detail

v1AdminUserCreatePost

@POST
@Path("/v1/admin/user/create")
@Consumes("application/json")
@Produces("application/json")
UserDetail v1AdminUserCreatePost(UserCreate body,
                                 @HeaderParam("sessionToken")
                                 String sessionToken)

Create a new user

v1AdminUserFindPost

@POST
@Path("/v1/admin/user/find")
@Consumes("application/json")
@Produces("application/json")
UserDetailList v1AdminUserFindPost(UserFilter body,
                                   @HeaderParam("sessionToken")
                                   String sessionToken,
                                   @QueryParam("skip")
                                   Integer skip,
                                   @QueryParam("limit")
                                   Integer limit)

Find a user based on attributes

v1AdminUserListGet

@GET
@Path("/v1/admin/user/list")
@Produces("application/json")
UserIdList v1AdminUserListGet(@HeaderParam("sessionToken")
                              String sessionToken)

Retreive a list of all users in the company (pod)

v1AdminUserUidAvatarGet

@GET
@Path("/v1/admin/user/{uid}/avatar")
@Produces("application/json")
AvatarList v1AdminUserUidAvatarGet(@HeaderParam("sessionToken")
                                   String sessionToken,
                                   @PathParam("uid")
                                   Long uid)

Get the URL of the avatar of a particular user

v1AdminUserUidAvatarUpdatePost

@POST
@Path("/v1/admin/user/{uid}/avatar/update")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidAvatarUpdatePost(AvatarUpdate body,
                                               @HeaderParam("sessionToken")
                                               String sessionToken,
                                               @PathParam("uid")
                                               Long uid)

Update the avatar of a particular user

v1AdminUserUidDelegatesGet

@GET
@Path("/v1/admin/user/{uid}/delegates")
@Produces("application/json")
IntegerList v1AdminUserUidDelegatesGet(@HeaderParam("sessionToken")
                                       String sessionToken,
                                       @PathParam("uid")
                                       Long uid)

Get the delegates assigned to a user

v1AdminUserUidDelegatesUpdatePost

@POST
@Path("/v1/admin/user/{uid}/delegates/update")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidDelegatesUpdatePost(DelegateAction body,
                                                  @HeaderParam("sessionToken")
                                                  String sessionToken,
                                                  @PathParam("uid")
                                                  Long uid)

Update the delegates assigned to a user

v1AdminUserUidDisclaimerDelete

@DELETE
@Path("/v1/admin/user/{uid}/disclaimer")
@Produces("application/json")
SuccessResponse v1AdminUserUidDisclaimerDelete(@HeaderParam("sessionToken")
                                               String sessionToken,
                                               @PathParam("uid")
                                               Long uid)

Unassign a disclaimer from a user

v1AdminUserUidDisclaimerGet

@GET
@Path("/v1/admin/user/{uid}/disclaimer")
@Produces("application/json")
Disclaimer v1AdminUserUidDisclaimerGet(@HeaderParam("sessionToken")
                                       String sessionToken,
                                       @PathParam("uid")
                                       Long uid)

Get the disclaimer assigned to a user

v1AdminUserUidDisclaimerUpdatePost

@POST
@Path("/v1/admin/user/{uid}/disclaimer/update")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidDisclaimerUpdatePost(StringId body,
                                                   @HeaderParam("sessionToken")
                                                   String sessionToken,
                                                   @PathParam("uid")
                                                   Long uid)

Assign a disclaimer to a user

v1AdminUserUidFeaturesGet

@GET
@Path("/v1/admin/user/{uid}/features")
@Produces("application/json")
FeatureList v1AdminUserUidFeaturesGet(@HeaderParam("sessionToken")
                                      String sessionToken,
                                      @PathParam("uid")
                                      Long uid)

Get the list of Symphony feature entitlements enabled for a particular user

v1AdminUserUidFeaturesUpdatePost

@POST
@Path("/v1/admin/user/{uid}/features/update")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidFeaturesUpdatePost(List<Feature> body,
                                                 @HeaderParam("sessionToken")
                                                 String sessionToken,
                                                 @PathParam("uid")
                                                 Long uid)

Update the list of Symphony feature entitlements for a particular user

v1AdminUserUidGet

@GET
@Path("/v1/admin/user/{uid}")
@Produces("application/json")
UserDetail v1AdminUserUidGet(@HeaderParam("sessionToken")
                             String sessionToken,
                             @PathParam("uid")
                             Long uid)

Retreive user details for a particular user

v1AdminUserUidRolesAddPost

@POST
@Path("/v1/admin/user/{uid}/roles/add")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidRolesAddPost(StringId body,
                                           @HeaderParam("sessionToken")
                                           String sessionToken,
                                           @PathParam("uid")
                                           Long uid)

Add a role to a user

v1AdminUserUidRolesRemovePost

@POST
@Path("/v1/admin/user/{uid}/roles/remove")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidRolesRemovePost(StringId body,
                                              @HeaderParam("sessionToken")
                                              String sessionToken,
                                              @PathParam("uid")
                                              Long uid)

Remove a role from a user

v1AdminUserUidStatusGet

@GET
@Path("/v1/admin/user/{uid}/status")
@Produces("application/json")
UserStatus v1AdminUserUidStatusGet(@HeaderParam("sessionToken")
                                   String sessionToken,
                                   @PathParam("uid")
                                   Long uid)

Get the status, active or inactive, for a particular user

v1AdminUserUidStatusUpdatePost

@POST
@Path("/v1/admin/user/{uid}/status/update")
@Consumes("application/json")
@Produces("application/json")
SuccessResponse v1AdminUserUidStatusUpdatePost(UserStatus body,
                                               @HeaderParam("sessionToken")
                                               String sessionToken,
                                               @PathParam("uid")
                                               Long uid)

Update the status of a particular user

v1AdminUserUidUpdatePost

@POST
@Path("/v1/admin/user/{uid}/update")
@Consumes("application/json")
@Produces("application/json")
UserDetail v1AdminUserUidUpdatePost(UserAttributes body,
                                    @HeaderParam("sessionToken")
                                    String sessionToken,
                                    @PathParam("uid")
                                    Long uid)

Update an existing user

v2AdminUserCreatePost

@POST
@Path("/v2/admin/user/create")
@Consumes("application/json")
@Produces("application/json")
V2UserDetail v2AdminUserCreatePost(V2UserCreate body,
                                   @HeaderParam("sessionToken")
                                   String sessionToken)

Create a new V2 User

v2AdminUserListGet

@GET
@Path("/v2/admin/user/list")
@Produces("application/json")
V2UserDetailList v2AdminUserListGet(@HeaderParam("sessionToken")
                                    String sessionToken,
                                    @QueryParam("skip")
                                    Integer skip,
                                    @QueryParam("limit")
                                    Integer limit)

Retrieve a list of all users in the company (pod)

v2AdminUserUidGet

@GET
@Path("/v2/admin/user/{uid}")
@Produces("application/json")
V2UserDetail v2AdminUserUidGet(@HeaderParam("sessionToken")
                               String sessionToken,
                               @PathParam("uid")
                               Long uid)

Retreive V2 User details for a particular user

v2AdminUserUidUpdatePost

@POST
@Path("/v2/admin/user/{uid}/update")
@Consumes("application/json")
@Produces("application/json")
V2UserDetail v2AdminUserUidUpdatePost(V2UserAttributes body,
                                      @HeaderParam("sessionToken")
                                      String sessionToken,
                                      @PathParam("uid")
                                      Long uid)

Update an existing V2 User

Interface UserApi