@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2021-10-18T12:11:35.250Z[Etc/UTC]")
public class UsersApi
extends java.lang.Object
Constructor and Description |
---|
UsersApi(com.symphony.bdk.http.api.ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
com.symphony.bdk.http.api.ApiClient |
getApiClient()
Get the API cilent
|
void |
setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
Set the API cilent
|
User |
v1UserGet(java.lang.String email,
java.lang.String sessionToken,
java.lang.Boolean local)
Deprecated.
|
com.symphony.bdk.http.api.ApiResponse<User> |
v1UserGetWithHttpInfo(java.lang.String email,
java.lang.String sessionToken,
java.lang.Boolean local)
Deprecated.
|
User |
v1UserNameUserNameGetGet(java.lang.String userName,
java.lang.String sessionToken)
Deprecated.
|
com.symphony.bdk.http.api.ApiResponse<User> |
v1UserNameUserNameGetGetWithHttpInfo(java.lang.String userName,
java.lang.String sessionToken)
Deprecated.
|
UserSearchResults |
v1UserSearchPost(java.lang.String sessionToken,
UserSearchQuery searchRequest,
java.lang.Integer skip,
java.lang.Integer limit,
java.lang.Boolean local)
Search for users by name or email address
|
com.symphony.bdk.http.api.ApiResponse<UserSearchResults> |
v1UserSearchPostWithHttpInfo(java.lang.String sessionToken,
UserSearchQuery searchRequest,
java.lang.Integer skip,
java.lang.Integer limit,
java.lang.Boolean local)
Search for users by name or email address
|
UserV2 |
v2UserGet(java.lang.String sessionToken,
java.lang.Long uid,
java.lang.String email,
java.lang.String username,
java.lang.Boolean local)
Get user information
|
com.symphony.bdk.http.api.ApiResponse<UserV2> |
v2UserGetWithHttpInfo(java.lang.String sessionToken,
java.lang.Long uid,
java.lang.String email,
java.lang.String username,
java.lang.Boolean local)
Get user information
|
V2UserList |
v3UsersGet(java.lang.String sessionToken,
java.lang.String uid,
java.lang.String email,
java.lang.String username,
java.lang.Boolean local,
java.lang.Boolean active)
Search users by emails or ids.
|
com.symphony.bdk.http.api.ApiResponse<V2UserList> |
v3UsersGetWithHttpInfo(java.lang.String sessionToken,
java.lang.String uid,
java.lang.String email,
java.lang.String username,
java.lang.Boolean local,
java.lang.Boolean active)
Search users by emails or ids.
|
public com.symphony.bdk.http.api.ApiClient getApiClient()
public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
apiClient
- an instance of API client@Deprecated public User v1UserGet(java.lang.String email, java.lang.String sessionToken, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public com.symphony.bdk.http.api.ApiResponse<User> v1UserGetWithHttpInfo(java.lang.String email, java.lang.String sessionToken, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public User v1UserNameUserNameGetGet(java.lang.String userName, java.lang.String sessionToken) throws com.symphony.bdk.http.api.ApiException
userName
- User login name (required)sessionToken
- Session authentication token. (required)com.symphony.bdk.http.api.ApiException
- if fails to make API call@Deprecated public com.symphony.bdk.http.api.ApiResponse<User> v1UserNameUserNameGetGetWithHttpInfo(java.lang.String userName, java.lang.String sessionToken) throws com.symphony.bdk.http.api.ApiException
userName
- User login name (required)sessionToken
- Session authentication token. (required)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic UserSearchResults v1UserSearchPost(java.lang.String sessionToken, UserSearchQuery searchRequest, java.lang.Integer skip, java.lang.Integer limit, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic com.symphony.bdk.http.api.ApiResponse<UserSearchResults> v1UserSearchPostWithHttpInfo(java.lang.String sessionToken, UserSearchQuery searchRequest, java.lang.Integer skip, java.lang.Integer limit, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic UserV2 v2UserGet(java.lang.String sessionToken, java.lang.Long uid, java.lang.String email, java.lang.String username, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic com.symphony.bdk.http.api.ApiResponse<UserV2> v2UserGetWithHttpInfo(java.lang.String sessionToken, java.lang.Long uid, java.lang.String email, java.lang.String username, java.lang.Boolean local) throws com.symphony.bdk.http.api.ApiException
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)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic V2UserList v3UsersGet(java.lang.String sessionToken, java.lang.String uid, java.lang.String email, java.lang.String username, java.lang.Boolean local, java.lang.Boolean active) throws com.symphony.bdk.http.api.ApiException
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)username
- List of username 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)active
- If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned (optional)com.symphony.bdk.http.api.ApiException
- if fails to make API callpublic com.symphony.bdk.http.api.ApiResponse<V2UserList> v3UsersGetWithHttpInfo(java.lang.String sessionToken, java.lang.String uid, java.lang.String email, java.lang.String username, java.lang.Boolean local, java.lang.Boolean active) throws com.symphony.bdk.http.api.ApiException
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)username
- List of username 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)active
- If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned (optional)com.symphony.bdk.http.api.ApiException
- if fails to make API call