```
@Path("/")
public interface UsersApi
```
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
`User`	`v1UserGet(String email, String sessionToken, Boolean local)`	Get user information by email address.
`User`	`v1UserNameUserNameGetGet(String userName, String sessionToken)`	Get user information by user (login) name.
`UserSearchResults`	`v1UserSearchPost(UserSearchQuery body, String sessionToken, Integer skip, Integer limit, Boolean local)`	Search for users by name or email address
`UserV2`	`v2UserGet(String sessionToken, Long uid, String email, String username, Boolean local)`	Get user information
`V2UserList`	`v3UsersGet(String sessionToken, String uid, String email, String username, Boolean local)`	Search users by emails or ids.

Method Detail

v1UserGet

@GET
@Path("/v1/user")
@Produces("application/json")
User v1UserGet(@QueryParam("email")
               String email,
               @HeaderParam("sessionToken")
               String sessionToken,
               @QueryParam("local")
               Boolean local)

Get user information by email address.

v1UserNameUserNameGetGet

@GET
@Path("/v1/user/name/{userName}/get")
@Produces("application/json")
User v1UserNameUserNameGetGet(@PathParam("userName")
                              String userName,
                              @HeaderParam("sessionToken")
                              String sessionToken)

Get user information by user (login) name. Searches for a user in the local pod with the given user name.

v1UserSearchPost

@POST
@Path("/v1/user/search")
@Consumes("application/json")
@Produces("application/json")
UserSearchResults v1UserSearchPost(UserSearchQuery body,
                                   @HeaderParam("sessionToken")
                                   String sessionToken,
                                   @QueryParam("skip")
                                   Integer skip,
                                   @QueryParam("limit")
                                   Integer limit,
                                   @QueryParam("local")
                                   Boolean local)

Search for users by name or email address

v2UserGet

@GET
@Path("/v2/user")
@Produces("application/json")
UserV2 v2UserGet(@HeaderParam("sessionToken")
                 String sessionToken,
                 @QueryParam("uid")
                 Long uid,
                 @QueryParam("email")
                 String email,
                 @QueryParam("username")
                 String username,
                 @QueryParam("local")
                 Boolean local)

Get user information

v3UsersGet

@GET
@Path("/v3/users")
@Produces("application/json")
V2UserList v3UsersGet(@HeaderParam("sessionToken")
                      String sessionToken,
                      @QueryParam("uid")
                      String uid,
                      @QueryParam("email")
                      String email,
                      @QueryParam("username")
                      String username,
                      @QueryParam("local")
                      Boolean local)

Search users by emails or ids. Only one of the search lists should be informed at a time. Search lists may containt up to 100 elements.