UserManagementApi

All requests use the primary/backup domains configured by the caller.

Method	HTTP request	Description
banUsers	POST /v4/user/ban	Ban a user
batchGetUserTags	POST /v4/user/tag/batch/get	Get user tags
batchSetUserTags	POST /v4/user/tag/batch/set	Batch set user tags
expireAccessToken	POST /v4/auth/access-token/expire	Expire an access token
getUser	POST /v4/user/get	Get user info
getUserConnectionStatus	POST /v4/user/connection-status/get	Check user online status
issueAccessToken	POST /v4/auth/access-token/issue	Register a user
listBannedUsers	POST /v4/user/ban/list	List banned users
listChannelTypeMute	POST /v4/channel-type/mute/list	List muted direct channel users
listSoftDeletedUsers	POST /v4/user/soft-deleted/list	Query soft-deleted users
restoreUsers	POST /v4/user/restore	Restore a user
setChannelTypeMute	POST /v4/channel-type/mute/set	Mute a user in direct channels
softDeleteUsers	POST /v4/user/soft-delete	Soft-delete a user
unbanUsers	POST /v4/user/unban	Unban a user
updateUser	POST /v4/user/update	Update user info

banUsers

CodeOnlyResponse banUsers(userBanRequest)

Ban a user

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserBanRequest userBanRequest = new UserBanRequest(); // UserBanRequest | 
    try {
      CodeOnlyResponse result = apiInstance.banUsers(userBanRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#banUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userBanRequest	UserBanRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

batchGetUserTags

UserTagBatchGetResponse batchGetUserTags(userTagBatchGetRequest)

Get user tags

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserTagBatchGetRequest userTagBatchGetRequest = new UserTagBatchGetRequest(); // UserTagBatchGetRequest | 
    try {
      UserTagBatchGetResponse result = apiInstance.batchGetUserTags(userTagBatchGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#batchGetUserTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userTagBatchGetRequest	UserTagBatchGetRequest

Return type

UserTagBatchGetResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

batchSetUserTags

CodeOnlyResponse batchSetUserTags(userTagBatchSetRequest)

Batch set user tags

Rate limit: 10/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserTagBatchSetRequest userTagBatchSetRequest = new UserTagBatchSetRequest(); // UserTagBatchSetRequest | 
    try {
      CodeOnlyResponse result = apiInstance.batchSetUserTags(userTagBatchSetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#batchSetUserTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userTagBatchSetRequest	UserTagBatchSetRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

expireAccessToken

CodeOnlyResponse expireAccessToken(accessTokenExpireRequest)

Expire an access token

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    AccessTokenExpireRequest accessTokenExpireRequest = new AccessTokenExpireRequest(); // AccessTokenExpireRequest | 
    try {
      CodeOnlyResponse result = apiInstance.expireAccessToken(accessTokenExpireRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#expireAccessToken");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accessTokenExpireRequest	AccessTokenExpireRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getUser

UserGetResponse getUser(userGetRequest)

Get user info

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserGetRequest userGetRequest = new UserGetRequest(); // UserGetRequest | 
    try {
      UserGetResponse result = apiInstance.getUser(userGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#getUser");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userGetRequest	UserGetRequest

Return type

UserGetResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getUserConnectionStatus

UserConnectionStatusResponse getUserConnectionStatus(userConnectionStatusRequest)

Check user online status

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserConnectionStatusRequest userConnectionStatusRequest = new UserConnectionStatusRequest(); // UserConnectionStatusRequest | 
    try {
      UserConnectionStatusResponse result = apiInstance.getUserConnectionStatus(userConnectionStatusRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#getUserConnectionStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userConnectionStatusRequest	UserConnectionStatusRequest

Return type

UserConnectionStatusResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

issueAccessToken

AccessTokenIssueResponse issueAccessToken(accessTokenIssueRequest)

Rate limit: 200/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    AccessTokenIssueRequest accessTokenIssueRequest = new AccessTokenIssueRequest(); // AccessTokenIssueRequest | 
    try {
      AccessTokenIssueResponse result = apiInstance.issueAccessToken(accessTokenIssueRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#issueAccessToken");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accessTokenIssueRequest	AccessTokenIssueRequest

Return type

AccessTokenIssueResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

listBannedUsers

UserBanListResponse listBannedUsers(userBanListRequest)

List banned users

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserBanListRequest userBanListRequest = new UserBanListRequest(); // UserBanListRequest | 
    try {
      UserBanListResponse result = apiInstance.listBannedUsers(userBanListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#listBannedUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userBanListRequest	UserBanListRequest

Return type

UserBanListResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

listChannelTypeMute

ChannelTypeMuteListResponse listChannelTypeMute(channelTypeMuteListRequest)

List muted direct channel users

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    ChannelTypeMuteListRequest channelTypeMuteListRequest = new ChannelTypeMuteListRequest(); // ChannelTypeMuteListRequest | 
    try {
      ChannelTypeMuteListResponse result = apiInstance.listChannelTypeMute(channelTypeMuteListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#listChannelTypeMute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
channelTypeMuteListRequest	ChannelTypeMuteListRequest

Return type

ChannelTypeMuteListResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

listSoftDeletedUsers

UserSoftDeletedListResponse listSoftDeletedUsers(userSoftDeletedListRequest)

Query soft-deleted users

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserSoftDeletedListRequest userSoftDeletedListRequest = new UserSoftDeletedListRequest(); // UserSoftDeletedListRequest | 
    try {
      UserSoftDeletedListResponse result = apiInstance.listSoftDeletedUsers(userSoftDeletedListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#listSoftDeletedUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userSoftDeletedListRequest	UserSoftDeletedListRequest

Return type

UserSoftDeletedListResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

restoreUsers

UserOperationResponse restoreUsers(userIdsMax100Request)

Restore a user

Rate limit: 100 users/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserIdsMax100Request userIdsMax100Request = new UserIdsMax100Request(); // UserIdsMax100Request | 
    try {
      UserOperationResponse result = apiInstance.restoreUsers(userIdsMax100Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#restoreUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userIdsMax100Request	UserIdsMax100Request

Return type

UserOperationResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

setChannelTypeMute

CodeOnlyResponse setChannelTypeMute(channelTypeMuteSetRequest)

Mute a user in direct channels

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    ChannelTypeMuteSetRequest channelTypeMuteSetRequest = new ChannelTypeMuteSetRequest(); // ChannelTypeMuteSetRequest | 
    try {
      CodeOnlyResponse result = apiInstance.setChannelTypeMute(channelTypeMuteSetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#setChannelTypeMute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
channelTypeMuteSetRequest	ChannelTypeMuteSetRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

softDeleteUsers

UserOperationResponse softDeleteUsers(userIdsMax100Request)

Soft-delete a user

Rate limit: 100 users/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserIdsMax100Request userIdsMax100Request = new UserIdsMax100Request(); // UserIdsMax100Request | 
    try {
      UserOperationResponse result = apiInstance.softDeleteUsers(userIdsMax100Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#softDeleteUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userIdsMax100Request	UserIdsMax100Request

Return type

UserOperationResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

unbanUsers

CodeOnlyResponse unbanUsers(userIdsMax20Request)

Unban a user

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserIdsMax20Request userIdsMax20Request = new UserIdsMax20Request(); // UserIdsMax20Request | 
    try {
      CodeOnlyResponse result = apiInstance.unbanUsers(userIdsMax20Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#unbanUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userIdsMax20Request	UserIdsMax20Request

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

updateUser

CodeOnlyResponse updateUser(userUpdateRequest)

Update user info

Rate limit: 100/sec.

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.UserManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    
    UserUpdateRequest userUpdateRequest = new UserUpdateRequest(); // UserUpdateRequest | 
    try {
      CodeOnlyResponse result = apiInstance.updateUser(userUpdateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserManagementApi#updateUser");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userUpdateRequest	UserUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

FilesExpand file tree

UserManagementApi.md

Latest commit

History

UserManagementApi.md

File metadata and controls

UserManagementApi

banUsers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchGetUserTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchSetUserTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

expireAccessToken

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUserConnectionStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

issueAccessToken

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listBannedUsers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listChannelTypeMute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listSoftDeletedUsers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restoreUsers

Example

Parameters