Package com.symphony.bdk.gen.api

Class UsersApi

java.lang.Object
com.symphony.bdk.gen.api.UsersApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:56.804588655Z[Etc/UTC]") public class UsersApi extends Object

  • Constructor Details

    • UsersApi

      public UsersApi(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

    • v1UserGet

      @Deprecated public User v1UserGet(String email, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<User> v1UserGetWithHttpInfo(String email, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      ApiResponse<User>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserNameUserNameGetGet

      @Deprecated public User v1UserNameUserNameGetGet(String userName, String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserNameUserNameGetGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<User> v1UserNameUserNameGetGetWithHttpInfo(String userName, String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      ApiResponse<User>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserSearchPost

      public UserSearchResults v1UserSearchPost(String sessionToken, UserSearchQuery searchRequest, Integer skip, Integer limit, Boolean local) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserSearchPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserSearchResults> v1UserSearchPostWithHttpInfo(String sessionToken, UserSearchQuery searchRequest, Integer skip, Integer limit, Boolean local) throws com.symphony.bdk.http.api.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:
      ApiResponse<UserSearchResults>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserGet

      public UserV2 v2UserGet(String sessionToken, Long uid, String email, String username, Boolean local) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserV2> v2UserGetWithHttpInfo(String sessionToken, Long uid, String email, String username, Boolean local) throws com.symphony.bdk.http.api.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:
      ApiResponse<UserV2>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UsersGet

      public V2UserList v3UsersGet(String sessionToken, String uid, String email, String username, Boolean local, Boolean active) throws com.symphony.bdk.http.api.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)
      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)
      Returns:
      V2UserList
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UsersGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V2UserList> v3UsersGetWithHttpInfo(String sessionToken, String uid, String email, String username, Boolean local, Boolean active) throws com.symphony.bdk.http.api.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)
      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)
      Returns:
      ApiResponse<V2UserList>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call