org.symphonyoss.symphony.pod.api

Class UserApi

java.lang.Object

org.symphonyoss.symphony.pod.api.UserApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:29:05.070-05:00")
public class UserApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserApi()
UserApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
UserDetail	v1AdminUserCreatePost(String sessionToken, UserCreate payload) Create a new user
UserDetailList	v1AdminUserFindPost(String sessionToken, UserFilter payload, 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(String sessionToken, Long uid, AvatarUpdate payload) Update the avatar of a particular user
IntegerList	v1AdminUserUidDelegatesGet(String sessionToken, Long uid) Get the delegates assigned to a user
SuccessResponse	v1AdminUserUidDelegatesUpdatePost(String sessionToken, Long uid, DelegateAction payload) Update the delegates assigned to a user
Disclaimer	v1AdminUserUidDisclaimerGet(String sessionToken, Long uid) Get the disclaimer assigned to a user
SuccessResponse	v1AdminUserUidDisclaimerUpdatePost(String sessionToken, Long uid, StringId payload) 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(String sessionToken, Long uid, FeatureList payload) 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(String sessionToken, Long uid, StringId payload) Add a role to a user
SuccessResponse	v1AdminUserUidRolesRemovePost(String sessionToken, Long uid, StringId payload) Remove a role from a user
UserStatus	v1AdminUserUidStatusGet(String sessionToken, Long uid) Get the status, active or inactive, for a particular user
SuccessResponse	v1AdminUserUidStatusUpdatePost(String sessionToken, Long uid, UserStatus payload) Update the status of a particular user
UserDetail	v1AdminUserUidUpdatePost(String sessionToken, Long uid, UserAttributes payload) Update an existing user

Methods inherited from class java.lang.Object

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

Constructor Detail

UserApi

public UserApi()

UserApi

public UserApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1AdminUserCreatePost

public UserDetail v1AdminUserCreatePost(String sessionToken,
                                        UserCreate payload)
                                 throws ApiException

Create a new user

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

UserDetail

Throws:

ApiException - if fails to make API call

v1AdminUserFindPost

public UserDetailList v1AdminUserFindPost(String sessionToken,
                                          UserFilter payload,
                                          Integer skip,
                                          Integer limit)
                                   throws ApiException

Find a user based on attributes

Parameters:

sessionToken - Session authentication token. (required)

payload - (required)

skip - Number of users to skip. Default is 0. Must be a integer equals or bigger than 0. (optional)

limit - Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000. (optional)

Returns:

UserDetailList

Throws:

ApiException - if fails to make API call

v1AdminUserListGet

public UserIdList v1AdminUserListGet(String sessionToken)
                              throws ApiException

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

Parameters:

sessionToken - Session authentication token. (required)

Returns:

UserIdList

Throws:

ApiException - if fails to make API call

v1AdminUserUidAvatarGet

public AvatarList v1AdminUserUidAvatarGet(String sessionToken,
                                          Long uid)
                                   throws ApiException

Get the URL of the avatar of a particular user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

AvatarList

Throws:

ApiException - if fails to make API call

v1AdminUserUidAvatarUpdatePost

public SuccessResponse v1AdminUserUidAvatarUpdatePost(String sessionToken,
                                                      Long uid,
                                                      AvatarUpdate payload)
                                               throws ApiException

Update the avatar of a particular user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidDelegatesGet

public IntegerList v1AdminUserUidDelegatesGet(String sessionToken,
                                              Long uid)
                                       throws ApiException

Get the delegates assigned to a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

IntegerList

Throws:

ApiException - if fails to make API call

v1AdminUserUidDelegatesUpdatePost

public SuccessResponse v1AdminUserUidDelegatesUpdatePost(String sessionToken,
                                                         Long uid,
                                                         DelegateAction payload)
                                                  throws ApiException

Update the delegates assigned to a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidDisclaimerGet

public Disclaimer v1AdminUserUidDisclaimerGet(String sessionToken,
                                              Long uid)
                                       throws ApiException

Get the disclaimer assigned to a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

Disclaimer

Throws:

ApiException - if fails to make API call

v1AdminUserUidDisclaimerUpdatePost

public SuccessResponse v1AdminUserUidDisclaimerUpdatePost(String sessionToken,
                                                          Long uid,
                                                          StringId payload)
                                                   throws ApiException

Assign a disclaimer to a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidFeaturesGet

public FeatureList v1AdminUserUidFeaturesGet(String sessionToken,
                                             Long uid)
                                      throws ApiException

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

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

FeatureList

Throws:

ApiException - if fails to make API call

v1AdminUserUidFeaturesUpdatePost

public SuccessResponse v1AdminUserUidFeaturesUpdatePost(String sessionToken,
                                                        Long uid,
                                                        FeatureList payload)
                                                 throws ApiException

Update the list of Symphony feature entitlements for a particular user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidGet

public UserDetail v1AdminUserUidGet(String sessionToken,
                                    Long uid)
                             throws ApiException

Retreive user details for a particular user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

UserDetail

Throws:

ApiException - if fails to make API call

v1AdminUserUidRolesAddPost

public SuccessResponse v1AdminUserUidRolesAddPost(String sessionToken,
                                                  Long uid,
                                                  StringId payload)
                                           throws ApiException

Add a role to a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidRolesRemovePost

public SuccessResponse v1AdminUserUidRolesRemovePost(String sessionToken,
                                                     Long uid,
                                                     StringId payload)
                                              throws ApiException

Remove a role from a user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidStatusGet

public UserStatus v1AdminUserUidStatusGet(String sessionToken,
                                          Long uid)
                                   throws ApiException

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

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

UserStatus

Throws:

ApiException - if fails to make API call

v1AdminUserUidStatusUpdatePost

public SuccessResponse v1AdminUserUidStatusUpdatePost(String sessionToken,
                                                      Long uid,
                                                      UserStatus payload)
                                               throws ApiException

Update the status of a particular user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminUserUidUpdatePost

public UserDetail v1AdminUserUidUpdatePost(String sessionToken,
                                           Long uid,
                                           UserAttributes payload)
                                    throws ApiException

Update an existing user

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

payload - (required)

Returns:

UserDetail

Throws:

ApiException - if fails to make API call