Help Center/ Virtual Private Network/ API Reference/ API/ P2C VPN APIs/ User Management/ Deleting VPN Users in Batches
Updated on 2024-12-03 GMT+08:00
View PDF
Share

Deleting VPN Users in Batches

Function

This API is used to delete VPN users with specified IDs in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/batch-delete

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.

Request

  • Request parameters
    Table 2 Request parameters

    Parameter

    Type

    Mandatory

    Description

    users

    Array of

    OpVpnUser

    objects

    Yes

    Specifies the list of VPN users to be deleted.
    Table 3 OpVpnUser

    Parameter

    Type

    Mandatory

    Description

    id

    String

    Yes
    • Specifies a user ID.
    • The value is a UUID containing 36 characters.
  • Example request 
    POST  https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users/batch-delete

{
  "users": [
	{
	  "id": "cc975b1d-ede5-448d-a47d-9dbf11f5d842"
	},
	{
	  "id": "30ad347e-e36e-42bd-a36b-c38f8ecc8bda"
	}
  ]
}

Response

  • Response parameters

    Returned status code 200: successful operation

Table 4 Parameters in the response body

Parameter

Type

Description

request_id

String

Specifies a request ID.
  • Example response 
    {
  "request_id": "c63d850876bcddbdfbd11776cce57914"
}

Status Codes

For details, see Status Codes.

Parent topic: User Management