Querying the VPN User List

Function

This API is used to query the user list based on a specified VPN server ID.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.
vpn_server_id	Yes	Specifies the ID of a VPN server.

**Table 2** Parameter in a query request
Parameter	Type	Mandatory	Description
limit	Integer	No	Specifies the number of records returned on each page during pagination query.
marker	String	No	Specifies the start flag for querying the current page. If this parameter is left blank, the first page is queried. The marker for querying the next page is the next_marker in the page_info object returned on the current page. This parameter must be used together with limit.

Request

Request parameters
None

Example request

GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users

Response

Response parameters

Returned status code 200: successful query

**Table 3** Parameters in the response body
Parameter	Type	Description
users	Array of VpnUser objects	Specifies user list information.
total_count	Integer	Specifies the total number of users on the current VPN server.
page_info	PageInfo object	Specifies pagination query information.
request_id	String	Specifies a request ID.

**Table 4** VpnUser
Parameter	Type	Description
id	String	Specifies a user ID. The value is a UUID containing 36 characters.
name	String	Specifies a username.
description	String	Specifies user description.
user_group_id	String	Specifies the ID of the user group to which the user belongs. The value is a UUID containing 36 characters.
user_group_name	String	Specifies the name of the user group to which the user belongs.
created_at	String	Specifies the creation time. The UTC time format is yyyy-MM-ddTHH:mm:ssZ.
updated_at	String	Specifies the update time. The UTC time format is yyyy-MM-ddTHH:mm:ssZ.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the marker of the next page. The value is the time when the last resource in the last query response was created.
current_count	Integer	Specifies the number of resources in the list.

Example response

{
    "users": [
        {
            "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
			"name": "user001",
			"description": "UserDescription1",
			"user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W",
			"user_group_name": "user-group1",
			"created_at": "2024-06-17T06:53:46.302Z",        
			"updated_at": "2024-06-17T06:53:46.302Z"
        },
		{
            "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
			"name": "user002",
			"description": "UserDescription2",
			"user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W",
			"user_group_name": "user-group1",
			"created_at": "2024-06-17T06:53:46.302Z",        
			"updated_at": "2024-06-17T06:53:46.302Z"
        }
    ],
    "total_count": 2,
    "page_info": {
        "next_marker": null,
        "current_count": 2
    },
    "request_id": "b04b68fb4d548344e0bc4b34dbd6f6e7"
}