Updated on 2026-10-22 GMT+08:00

Removing a VPN User from a Group

Function

This API is used to remove a VPN user from a specified user group.

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:removeUsers

write

p2cVpnUser

-

-

-

p2cVpnGateway

g:ResourceTag/<tag-key>

URI

POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/remove-users

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 VPN user group.

Request

  • Request parameters
    Table 2 Request parameters

    Parameter

    Type

    Mandatory

    Description

    users

    Array of OpVpnUser objects

    Yes

    Specifies the VPN user list.

    Table 3 OpVpnUser

    Parameter

    Type

    Mandatory

    Description

    id

    String

    Yes

    • Specifies the ID of a VPN user.
    • The value is a UUID containing 36 characters.
    • Example request
      POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/remove-users
      
      {
        "users": [
          {
            "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d"
          }
        ]
      }

Response

  • Response parameters

    Returned status code 201: successful operation

    Table 4 Parameters in the response body

    Parameter

    Type

    Description

    request_id

    String

    Specifies a request ID.

    • Example response
      {
          "request_id": "254ee8ac1d39c2a0ec6200447b676e18"
      }

Status Codes

For details, see Status Codes.