Package com.symphony.bdk.gen.api
Class UserApi
java.lang.Object
com.symphony.bdk.gen.api.UserApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-09-12T12:09:08.197490749Z[Etc/UTC]")
public class UserApi
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncom.symphony.bdk.http.api.ApiClient
Get the API cilentvoid
setApiClient
(com.symphony.bdk.http.api.ApiClient apiClient) Set the API cilentv1AdminSystemRolesListGet
(String sessionToken) Get a list of all roles available in the company (pod)com.symphony.bdk.http.api.ApiResponse<List<RoleDetail>>
v1AdminSystemRolesListGetWithHttpInfo
(String sessionToken) Get a list of all roles available in the company (pod)v1AdminUserCreatePost
(String sessionToken, UserCreate payload) Deprecated.com.symphony.bdk.http.api.ApiResponse<UserDetail>
v1AdminUserCreatePostWithHttpInfo
(String sessionToken, UserCreate payload) Deprecated.v1AdminUserFindPost
(String sessionToken, UserFilter payload, Integer skip, Integer limit) Find a user based on attributescom.symphony.bdk.http.api.ApiResponse<List<UserDetail>>
v1AdminUserFindPostWithHttpInfo
(String sessionToken, UserFilter payload, Integer skip, Integer limit) Find a user based on attributesv1AdminUserListGet
(String sessionToken) Deprecated.v1AdminUserListGetWithHttpInfo
(String sessionToken) Deprecated.v1AdminUserUidAvatarGet
(String sessionToken, Long uid) Get the URL of the avatar of a particular userv1AdminUserUidAvatarGetWithHttpInfo
(String sessionToken, Long uid) Get the URL of the avatar of a particular userv1AdminUserUidAvatarUpdatePost
(String sessionToken, Long uid, AvatarUpdate payload) Update the avatar of a particular usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidAvatarUpdatePostWithHttpInfo
(String sessionToken, Long uid, AvatarUpdate payload) Update the avatar of a particular userv1AdminUserUidDelegatesGet
(String sessionToken, Long uid) Get the delegates assigned to a userv1AdminUserUidDelegatesGetWithHttpInfo
(String sessionToken, Long uid) Get the delegates assigned to a userv1AdminUserUidDelegatesUpdatePost
(String sessionToken, Long uid, DelegateAction payload) Update the delegates assigned to a usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidDelegatesUpdatePostWithHttpInfo
(String sessionToken, Long uid, DelegateAction payload) Update the delegates assigned to a userv1AdminUserUidDisclaimerDelete
(String sessionToken, Long uid) Unassign a disclaimer from a usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidDisclaimerDeleteWithHttpInfo
(String sessionToken, Long uid) Unassign a disclaimer from a userv1AdminUserUidDisclaimerGet
(String sessionToken, Long uid) Get the disclaimer assigned to a usercom.symphony.bdk.http.api.ApiResponse<Disclaimer>
v1AdminUserUidDisclaimerGetWithHttpInfo
(String sessionToken, Long uid) Get the disclaimer assigned to a userv1AdminUserUidDisclaimerUpdatePost
(String sessionToken, Long uid, StringId payload) Assign a disclaimer to a usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidDisclaimerUpdatePostWithHttpInfo
(String sessionToken, Long uid, StringId payload) Assign a disclaimer to a userv1AdminUserUidFeaturesGet
(String sessionToken, Long uid) Get the list of Symphony feature entitlements enabled for a particular userv1AdminUserUidFeaturesGetWithHttpInfo
(String sessionToken, Long uid) Get the list of Symphony feature entitlements enabled for a particular userv1AdminUserUidFeaturesUpdatePost
(String sessionToken, Long uid, List<Feature> payload) Update the list of Symphony feature entitlements for a particular usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidFeaturesUpdatePostWithHttpInfo
(String sessionToken, Long uid, List<Feature> payload) Update the list of Symphony feature entitlements for a particular userv1AdminUserUidGet
(String sessionToken, Long uid) Deprecated.com.symphony.bdk.http.api.ApiResponse<UserDetail>
v1AdminUserUidGetWithHttpInfo
(String sessionToken, Long uid) Deprecated.v1AdminUserUidRolesAddPost
(String sessionToken, Long uid, StringId payload) Add a role to a usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidRolesAddPostWithHttpInfo
(String sessionToken, Long uid, StringId payload) Add a role to a userv1AdminUserUidRolesRemovePost
(String sessionToken, Long uid, StringId payload) Remove a role from a usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidRolesRemovePostWithHttpInfo
(String sessionToken, Long uid, StringId payload) Remove a role from a userv1AdminUserUidStatusGet
(String sessionToken, Long uid) Get the status, active or inactive, for a particular usercom.symphony.bdk.http.api.ApiResponse<UserStatus>
v1AdminUserUidStatusGetWithHttpInfo
(String sessionToken, Long uid) Get the status, active or inactive, for a particular userv1AdminUserUidStatusUpdatePost
(String sessionToken, Long uid, UserStatus payload) Update the status of a particular usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUidStatusUpdatePostWithHttpInfo
(String sessionToken, Long uid, UserStatus payload) Update the status of a particular userv1AdminUserUidUpdatePost
(String sessionToken, Long uid, UserAttributes payload) Deprecated.com.symphony.bdk.http.api.ApiResponse<UserDetail>
v1AdminUserUidUpdatePostWithHttpInfo
(String sessionToken, Long uid, UserAttributes payload) Deprecated.v1AdminUserUserIdSuspensionUpdatePut
(String sessionToken, Long userId, UserSuspension payload) Update the status of suspension of a particular usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminUserUserIdSuspensionUpdatePutWithHttpInfo
(String sessionToken, Long userId, UserSuspension payload) Update the status of suspension of a particular userReturns the list of followers for a specific usercom.symphony.bdk.http.api.ApiResponse<FollowersListResponse>
v1UserUidFollowersGetWithHttpInfo
(String sessionToken, Long uid, Integer limit, String before, String after) Returns the list of followers for a specific userReturns the list of users that a specific user is followingcom.symphony.bdk.http.api.ApiResponse<FollowingListResponse>
v1UserUidFollowingGetWithHttpInfo
(String sessionToken, Long uid, Integer limit, String before, String after) Returns the list of users that a specific user is followingv1UserUidFollowPost
(String sessionToken, Long uid, FollowersList uidList) Make a list of users start following a specific usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1UserUidFollowPostWithHttpInfo
(String sessionToken, Long uid, FollowersList uidList) Make a list of users start following a specific userv1UserUidUnfollowPost
(String sessionToken, Long uid, FollowersList uidList) Make a list of users unfollowing a specific usercom.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1UserUidUnfollowPostWithHttpInfo
(String sessionToken, Long uid, FollowersList uidList) Make a list of users unfollowing a specific userv2AdminUserCreatePost
(String sessionToken, V2UserCreate payload) Create a new V2 Usercom.symphony.bdk.http.api.ApiResponse<V2UserDetail>
v2AdminUserCreatePostWithHttpInfo
(String sessionToken, V2UserCreate payload) Create a new V2 Userv2AdminUserListGet
(String sessionToken, Integer skip, Integer limit) Retrieve a list of all users in the company (pod)com.symphony.bdk.http.api.ApiResponse<List<V2UserDetail>>
v2AdminUserListGetWithHttpInfo
(String sessionToken, Integer skip, Integer limit) Retrieve a list of all users in the company (pod)v2AdminUserUidGet
(String sessionToken, Long uid) Retreive V2 User details for a particular usercom.symphony.bdk.http.api.ApiResponse<V2UserDetail>
v2AdminUserUidGetWithHttpInfo
(String sessionToken, Long uid) Retreive V2 User details for a particular userv2AdminUserUidUpdatePost
(String sessionToken, Long uid, V2UserAttributes payload) Update an existing V2 Usercom.symphony.bdk.http.api.ApiResponse<V2UserDetail>
v2AdminUserUidUpdatePostWithHttpInfo
(String sessionToken, Long uid, V2UserAttributes payload) Update an existing V2 User
-
Constructor Details
-
UserApi
public UserApi(com.symphony.bdk.http.api.ApiClient apiClient)
-
-
Method Details
-
getApiClient
public com.symphony.bdk.http.api.ApiClient getApiClient()Get the API cilent- Returns:
- API client
-
setApiClient
public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient) Set the API cilent- Parameters:
apiClient
- an instance of API client
-
v1AdminSystemRolesListGet
public List<RoleDetail> v1AdminSystemRolesListGet(String sessionToken) throws com.symphony.bdk.http.api.ApiException Get a list of all roles available in the company (pod)- Parameters:
sessionToken
- Session authentication token. (required)- Returns:
- List<RoleDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminSystemRolesListGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<RoleDetail>> v1AdminSystemRolesListGetWithHttpInfo(String sessionToken) throws com.symphony.bdk.http.api.ApiException Get a list of all roles available in the company (pod)- Parameters:
sessionToken
- Session authentication token. (required)- Returns:
- ApiResponse<List<RoleDetail>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserCreatePost
@Deprecated public UserDetail v1AdminUserCreatePost(String sessionToken, UserCreate payload) throws com.symphony.bdk.http.api.ApiException Deprecated.Create a new user- Parameters:
sessionToken
- Session authentication token. (required)payload
- (required)- Returns:
- UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserCreatePostWithHttpInfo
@Deprecated public com.symphony.bdk.http.api.ApiResponse<UserDetail> v1AdminUserCreatePostWithHttpInfo(String sessionToken, UserCreate payload) throws com.symphony.bdk.http.api.ApiException Deprecated.Create a new user- Parameters:
sessionToken
- Session authentication token. (required)payload
- (required)- Returns:
- ApiResponse<UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserFindPost
public List<UserDetail> v1AdminUserFindPost(String sessionToken, UserFilter payload, Integer skip, Integer limit) throws com.symphony.bdk.http.api.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:
- List<UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserFindPostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<UserDetail>> v1AdminUserFindPostWithHttpInfo(String sessionToken, UserFilter payload, Integer skip, Integer limit) throws com.symphony.bdk.http.api.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:
- ApiResponse<List<UserDetail>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserListGet
@Deprecated public List<Long> v1AdminUserListGet(String sessionToken) throws com.symphony.bdk.http.api.ApiException Deprecated.Retreive a list of all users in the company (pod)- Parameters:
sessionToken
- Session authentication token. (required)- Returns:
- List<Long>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserListGetWithHttpInfo
@Deprecated public com.symphony.bdk.http.api.ApiResponse<List<Long>> v1AdminUserListGetWithHttpInfo(String sessionToken) throws com.symphony.bdk.http.api.ApiException Deprecated.Retreive a list of all users in the company (pod)- Parameters:
sessionToken
- Session authentication token. (required)- Returns:
- ApiResponse<List<Long>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidAvatarGet
public List<Avatar> v1AdminUserUidAvatarGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
- List<Avatar>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidAvatarGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<Avatar>> v1AdminUserUidAvatarGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
- ApiResponse<List<Avatar>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidAvatarUpdatePost
public SuccessResponse v1AdminUserUidAvatarUpdatePost(String sessionToken, Long uid, AvatarUpdate payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidAvatarUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidAvatarUpdatePostWithHttpInfo(String sessionToken, Long uid, AvatarUpdate payload) throws com.symphony.bdk.http.api.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:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDelegatesGet
public List<Long> v1AdminUserUidDelegatesGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Get the delegates assigned to a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- List<Long>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDelegatesGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<Long>> v1AdminUserUidDelegatesGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Get the delegates assigned to a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- ApiResponse<List<Long>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDelegatesUpdatePost
public SuccessResponse v1AdminUserUidDelegatesUpdatePost(String sessionToken, Long uid, DelegateAction payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDelegatesUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidDelegatesUpdatePostWithHttpInfo(String sessionToken, Long uid, DelegateAction payload) throws com.symphony.bdk.http.api.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:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerDelete
public SuccessResponse v1AdminUserUidDisclaimerDelete(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Unassign a disclaimer from a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- SuccessResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerDeleteWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidDisclaimerDeleteWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Unassign a disclaimer from a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerGet
public Disclaimer v1AdminUserUidDisclaimerGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<Disclaimer> v1AdminUserUidDisclaimerGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Get the disclaimer assigned to a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- ApiResponse<Disclaimer>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerUpdatePost
public SuccessResponse v1AdminUserUidDisclaimerUpdatePost(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidDisclaimerUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidDisclaimerUpdatePostWithHttpInfo(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.ApiException Assign a disclaimer to a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidFeaturesGet
public List<Feature> v1AdminUserUidFeaturesGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
- List<Feature>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidFeaturesGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<Feature>> v1AdminUserUidFeaturesGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
- ApiResponse<List<Feature>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidFeaturesUpdatePost
public SuccessResponse v1AdminUserUidFeaturesUpdatePost(String sessionToken, Long uid, List<Feature> payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidFeaturesUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidFeaturesUpdatePostWithHttpInfo(String sessionToken, Long uid, List<Feature> payload) throws com.symphony.bdk.http.api.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:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidGet
@Deprecated public UserDetail v1AdminUserUidGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Deprecated.Retreive user details for a particular user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidGetWithHttpInfo
@Deprecated public com.symphony.bdk.http.api.ApiResponse<UserDetail> v1AdminUserUidGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Deprecated.Retreive user details for a particular user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- ApiResponse<UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidRolesAddPost
public SuccessResponse v1AdminUserUidRolesAddPost(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidRolesAddPostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidRolesAddPostWithHttpInfo(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.ApiException Add a role to a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidRolesRemovePost
public SuccessResponse v1AdminUserUidRolesRemovePost(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidRolesRemovePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidRolesRemovePostWithHttpInfo(String sessionToken, Long uid, StringId payload) throws com.symphony.bdk.http.api.ApiException Remove a role from a user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidStatusGet
public UserStatus v1AdminUserUidStatusGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidStatusGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<UserStatus> v1AdminUserUidStatusGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.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:
- ApiResponse<UserStatus>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidStatusUpdatePost
public SuccessResponse v1AdminUserUidStatusUpdatePost(String sessionToken, Long uid, UserStatus payload) throws com.symphony.bdk.http.api.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:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidStatusUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUidStatusUpdatePostWithHttpInfo(String sessionToken, Long uid, UserStatus payload) throws com.symphony.bdk.http.api.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:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidUpdatePost
@Deprecated public UserDetail v1AdminUserUidUpdatePost(String sessionToken, Long uid, UserAttributes payload) throws com.symphony.bdk.http.api.ApiException Deprecated.Update an existing user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUidUpdatePostWithHttpInfo
@Deprecated public com.symphony.bdk.http.api.ApiResponse<UserDetail> v1AdminUserUidUpdatePostWithHttpInfo(String sessionToken, Long uid, UserAttributes payload) throws com.symphony.bdk.http.api.ApiException Deprecated.Update an existing user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUserIdSuspensionUpdatePut
public SuccessResponse v1AdminUserUserIdSuspensionUpdatePut(String sessionToken, Long userId, UserSuspension payload) throws com.symphony.bdk.http.api.ApiException Update the status of suspension of a particular user- Parameters:
sessionToken
- Session authentication token (required)userId
- User ID as a decimal integer (required)payload
- (required)- Returns:
- SuccessResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1AdminUserUserIdSuspensionUpdatePutWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminUserUserIdSuspensionUpdatePutWithHttpInfo(String sessionToken, Long userId, UserSuspension payload) throws com.symphony.bdk.http.api.ApiException Update the status of suspension of a particular user- Parameters:
sessionToken
- Session authentication token (required)userId
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowPost
public SuccessResponse v1UserUidFollowPost(String sessionToken, Long uid, FollowersList uidList) throws com.symphony.bdk.http.api.ApiException Make a list of users start following a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user to be followed (required)uidList
- List of (integer) User IDs of the followers (required)- Returns:
- SuccessResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowPostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1UserUidFollowPostWithHttpInfo(String sessionToken, Long uid, FollowersList uidList) throws com.symphony.bdk.http.api.ApiException Make a list of users start following a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user to be followed (required)uidList
- List of (integer) User IDs of the followers (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowersGet
public FollowersListResponse v1UserUidFollowersGet(String sessionToken, Long uid, Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException Returns the list of followers for a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user we want to get the followers list (required)limit
- This is the maximum number of objects that may be returned. (optional)before
- Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)after
- Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)- Returns:
- FollowersListResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowersGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<FollowersListResponse> v1UserUidFollowersGetWithHttpInfo(String sessionToken, Long uid, Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException Returns the list of followers for a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user we want to get the followers list (required)limit
- This is the maximum number of objects that may be returned. (optional)before
- Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)after
- Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)- Returns:
- ApiResponse<FollowersListResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowingGet
public FollowingListResponse v1UserUidFollowingGet(String sessionToken, Long uid, Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException Returns the list of users that a specific user is following- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user we want to get the following list (required)limit
- This is the maximum number of objects that may be returned. (optional)before
- Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)after
- Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)- Returns:
- FollowingListResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidFollowingGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<FollowingListResponse> v1UserUidFollowingGetWithHttpInfo(String sessionToken, Long uid, Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException Returns the list of users that a specific user is following- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user we want to get the following list (required)limit
- This is the maximum number of objects that may be returned. (optional)before
- Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)after
- Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)- Returns:
- ApiResponse<FollowingListResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidUnfollowPost
public SuccessResponse v1UserUidUnfollowPost(String sessionToken, Long uid, FollowersList uidList) throws com.symphony.bdk.http.api.ApiException Make a list of users unfollowing a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user to be unfollowed (required)uidList
- List of (integer) User IDs of the followers (required)- Returns:
- SuccessResponse
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v1UserUidUnfollowPostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1UserUidUnfollowPostWithHttpInfo(String sessionToken, Long uid, FollowersList uidList) throws com.symphony.bdk.http.api.ApiException Make a list of users unfollowing a specific user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer of the user to be unfollowed (required)uidList
- List of (integer) User IDs of the followers (required)- Returns:
- ApiResponse<SuccessResponse>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserCreatePost
public V2UserDetail v2AdminUserCreatePost(String sessionToken, V2UserCreate payload) throws com.symphony.bdk.http.api.ApiException Create a new V2 User- Parameters:
sessionToken
- Session authentication token. (required)payload
- (required)- Returns:
- V2UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserCreatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<V2UserDetail> v2AdminUserCreatePostWithHttpInfo(String sessionToken, V2UserCreate payload) throws com.symphony.bdk.http.api.ApiException Create a new V2 User- Parameters:
sessionToken
- Session authentication token. (required)payload
- (required)- Returns:
- ApiResponse<V2UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserListGet
public List<V2UserDetail> v2AdminUserListGet(String sessionToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException Retrieve a list of all users in the company (pod)- Parameters:
sessionToken
- Session Authentication token. (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:
- List<V2UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserListGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<List<V2UserDetail>> v2AdminUserListGetWithHttpInfo(String sessionToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException Retrieve a list of all users in the company (pod)- Parameters:
sessionToken
- Session Authentication token. (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:
- ApiResponse<List<V2UserDetail>>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserUidGet
public V2UserDetail v2AdminUserUidGet(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Retreive V2 User details for a particular user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- V2UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserUidGetWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<V2UserDetail> v2AdminUserUidGetWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException Retreive V2 User details for a particular user- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)- Returns:
- ApiResponse<V2UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserUidUpdatePost
public V2UserDetail v2AdminUserUidUpdatePost(String sessionToken, Long uid, V2UserAttributes payload) throws com.symphony.bdk.http.api.ApiException Update an existing V2 User- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- V2UserDetail
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-
v2AdminUserUidUpdatePostWithHttpInfo
public com.symphony.bdk.http.api.ApiResponse<V2UserDetail> v2AdminUserUidUpdatePostWithHttpInfo(String sessionToken, Long uid, V2UserAttributes payload) throws com.symphony.bdk.http.api.ApiException Update an existing V2 User- Parameters:
sessionToken
- Session authentication token. (required)uid
- User ID as a decimal integer (required)payload
- (required)- Returns:
- ApiResponse<V2UserDetail>
- Throws:
com.symphony.bdk.http.api.ApiException
- if fails to make API call
-