Skip to main content

Paginated Query for Group Information

This API allows you to query group information for a specified application, with results returned in paginated format.

Enabling the Service

Before using this feature, you must enable the profile hosting service by submitting a ticket.

Request Method

POST: https://data center domain/entrust/group/query.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. See API Request Signature for details.

Request Parameters

The HTTP request body uses application/x-www-form-urlencoded format and supports the following form parameters:

ParameterTypeRequiredDescription
pageTokenStringNoPage token from the previous response. Omit for initial request.
sizeNumberNoItems per page. Default: 50, Max: 1000.
orderNumberNoSort by group creation time:
  • 0: Ascending
  • 1: Descending (default)

Request Example

POST /entrust/group/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

pageToken=XXXXXX&order=1&size=50

Response

The HTTP response body contains a JSON object with the following structure:

FieldTypeDescription
codeNumberStatus code. 200 indicates success.
pageTokenStringPage token for next request, if available.
groupsJSONArrayList of group information.
groups structure
groups[i].groupIdStringGroup ID
groups[i].nameStringGroup name
groups[i].groupProfileStringBasic group information in JSON format.
groups[i].creatorStringGroup creator.
groups[i].ownerStringGroup owner
groups[i].timeLongGroup creation time

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code":200,
"pageToken": "XXXX",
"groups":[
{
"groupId":"g123",
"owner":"u23",
"creator":"u12",
"name":"g1231",
"portraitUrl":"XXX",
"time": 1709619756077
},
{
"groupId":"g456",
"owner":"u2333",
"creator":"u1332",
"name":"g1231",
"time": 1709619756077
}]
}