org.symphonyoss.symphony.pod.api

Class UsersApi

java.lang.Object

org.symphonyoss.symphony.pod.api.UsersApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-01-28T11:18:17.901-05:00")
public class UsersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
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(String sessionToken, UserSearchQuery searchRequest, 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, Boolean local) Search users by emails or ids.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1UserGet

public User v1UserGet(String email,
                      String sessionToken,
                      Boolean local)
               throws ApiException

Get user information by email address.

Parameters:

email - Email address (required)

sessionToken - Session authentication token. (required)

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned. (optional)

Returns:

User

Throws:

ApiException - if fails to make API call

v1UserNameUserNameGetGet

public User v1UserNameUserNameGetGet(String userName,
                                     String sessionToken)
                              throws ApiException

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

Parameters:

userName - User login name (required)

sessionToken - Session authentication token. (required)

Returns:

User

Throws:

ApiException - if fails to make API call

v1UserSearchPost

public UserSearchResults v1UserSearchPost(String sessionToken,
                                          UserSearchQuery searchRequest,
                                          Integer skip,
                                          Integer limit,
                                          Boolean local)
                                   throws ApiException

Search for users by name or email address

Parameters:

sessionToken - Session authentication token. (required)

searchRequest - search criteria (required)

skip - number of records to skip (optional)

limit - Max number of records to return. If no value is provided, 50 is the default. (optional)

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned. (optional)

Returns:

UserSearchResults

Throws:

ApiException - if fails to make API call

v2UserGet

public UserV2 v2UserGet(String sessionToken,
                        Long uid,
                        String email,
                        String username,
                        Boolean local)
                 throws ApiException

Get user information

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (optional)

email - Email address (optional)

username - login user name (optional)

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned. Note: for username search, the local flag must be true (optional)

Returns:

UserV2

Throws:

ApiException - if fails to make API call

v3UsersGet

public V2UserList v3UsersGet(String sessionToken,
                             String uid,
                             String email,
                             Boolean local)
                      throws ApiException

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.

Parameters:

sessionToken - Session authentication token. (required)

uid - User IDs as a list of decimal integers separated by comma (optional)

email - List of email addresses separated by comma (optional)

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned. (optional)

Returns:

V2UserList

Throws:

ApiException - if fails to make API call