Querying a VPN User Group_User Management_P2C VPN APIs_API_API Reference

Function

This API is used to query information about a VPN user group with a specified ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpn:p2cVpnGateway:getUserGroup	read	p2cVpnGateway	g:ResourceTag/<tag-key>	-	-

URI

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

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

Request

Request parameters
None

Example request

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

Response

Response parameters

Returned status code 200: successful query

**Table 2** Parameters in the response body
Parameter	Type	Description
user_group	VpnUserGroup object	Specifies the VPN user group object.
request_id	String	Specifies a request ID.

**Table 3** VpnUserGroup
Parameter	Type	Description
id	String	Specifies the ID of a VPN user group. The value is a UUID containing 36 characters.
name	String	Specifies the name of a user group.
description	String	Specifies user group description.
type	String	Specifies the type of a user group. Value range: Default: default user group Custom: custom user group
user_number	Integer	Specifies the number of users.
created_at	String	Specifies the creation time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
updated_at	String	Specifies the update time. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

Example response

{
    "user_group": {
        "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8",
        "name": "user-group1",
        "description": "UserGroup1",
        "type": "Custom",
        "user_number": 0,
        "created_at": "2024-06-17T09:48:27.548Z",
        "updated_at": "2024-06-17T09:48:27.548Z"
    },
    "request_id": "6735d32bb3e35e9154caba1dbc6c2dc6"
}

Status Codes

For details, see Status Codes.

Querying a VPN User Group