get_all_users_uid

Brief Description

• Retrieve a list of registered user IDs.

Request Method

• post

Request URL

• http://x.x.x.x:10002/user/get_all_users_uid

Header

Header Name	Sample Value	Optional	Type	Description
operationID	1646445464564	Mandatory	string	operationID for global link tracing
token	eyJhbxxxx3Xs	Mandatory	string	Admin token

Request Parameter Example

{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}

Field Name	Optional	Type	Description
pagination	Mandatory	object	Pagination parameter structure
pagination.pageNumber	Mandatory	int	Current page number, starting from 1
pagination.showNumber	Mandatory	int	Number of requests on the current page

Successful Response Example

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 0,
    "userIDs": [
      "openIM123456",
      "openIM654321",
      "openIMAdmin",
      "kernaltestuid2",
      "alantestuid2"
    ]
  }
}

Successful Response Parameters Explanation

Parameter Name	Type	Description
errCode	int	Error code, 0 indicates success
errMsg	string	Brief error message, empty if no error
errDlt	errDlt	Detailed error message, empty if no error
data	object	Generic data object, see structure below
total	int	Total number of users
userIDs	array	List of user IDs

Failed Response Example

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Failed Response Parameters Explanation

Parameter Name	Type	Description
errCode	int	Error code, refer to global error code document for details
errMsg	string	Brief error message
errDlt	errDlt	Detailed error message