v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Proxy User

Edit Proxy User

This endpoint allows a user to edit an existing Proxy User entry by providing the necessary proxy_user_id.

For access control, use the ProxyUserAcl endpoints to manage specific service or proxy access when using "service_restricted" or "proxy_restricted" access types.

patch/public/user/proxy_user/edit/{proxy_user_id}

Path parameters

proxy_user_idstring required

ID of the proxy user record to edit.

Headers

Content-Typestring required

Content type for the request body as application/json.

Request body

clear_proxy_user_aclboolean

When changing access_type, set to True to clear all existing ProxyUserAcl entries. Required when changing to "all" if ACLs exist. Optional for other access_type changes.

ip_address_authenticationsstring[]

A list of valid IP addresses authenticated for this Proxy User.

proxy_user_access_type'all' | 'service_restricted' | 'proxy_restricted'

Access control type for the proxy user:

"all": Unrestricted access
"service_restricted": Access restricted by ProxyUserAcl service entries
"proxy_restricted": Access restricted by ProxyUserAcl proxy entries

Note: Default proxy users (proxy_user_is_default=true) must always have access_type "all" and cannot be changed to restricted access types.

proxy_user_enforce_httpsboolean

If true, this Proxy User can only access targets on port 443 (HTTPS). This is useful for enforcing secure connections.

proxy_user_is_strict_securityboolean

Enable or disable strict security for the Proxy User.

proxy_user_metadataobject

Arbitrary metadata object associated with the Proxy User. Constraints

Supports string, boolean, float and integer values.
Must be a non-nested JSON object.
Maximum 30 keys.
Each value's string representation ≤ 300 characters.
Total size ≤ 32KB.

proxy_user_mobile_bytes_limitinteger

The mobile bytes limit for the Proxy User (must be ≥ current usage).

proxy_user_passwordstring

The new password for the Proxy User. Must be alphanumeric, 10 to 32 characters.

proxy_user_residential_bytes_limitinteger

The residential bytes limit for the Proxy User (must be ≥ current usage).

Example request

{
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_metadata": {
    "internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706"
  },
  "proxy_user_mobile_bytes_limit": 1000000,
  "proxy_user_password": "newPass1241233",
  "proxy_user_residential_bytes_limit": 1000000
}

Response

Proxy User Successfully Edited

editedstring[]

List of Proxy User IDs that were successfully edited.

messagestring

Success message indicating the Proxy User was edited.

proxy_user_acl_deletedstring[]

List of ProxyUserAcl IDs that were deleted during the edit operation (when access_type is set to "all").

Example response

{
  "edited": [
    "stevejobs"
  ],
  "message": "Proxy User successfully edited.",
  "proxy_user_acl_deleted": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}