Edit Proxy User

Edit Proxy User

curl --request PATCH \
  --url https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "clear_proxy_user_acl": true,
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_enforce_https": false,
  "proxy_user_is_strict_security": false,
  "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
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"

payload = {
    "clear_proxy_user_acl": True,
    "ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
    "proxy_user_enforce_https": False,
    "proxy_user_is_strict_security": False,
    "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
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    clear_proxy_user_acl: true,
    ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
    proxy_user_enforce_https: false,
    proxy_user_is_strict_security: false,
    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
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'clear_proxy_user_acl' => true,
    'ip_address_authentications' => [
        '1.1.1.1',
        '2.2.2.2'
    ],
    'proxy_user_enforce_https' => false,
    'proxy_user_is_strict_security' => false,
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Private-Key: <api-key>",
    "X-API-Public-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"

	payload := strings.NewReader("{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Private-Key", "<api-key>")
	req.Header.Add("X-API-Public-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}"

response = http.request(request)
puts response.read_body

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

PATCH

public

user

proxy_user

edit

{proxy_user_id}

Edit Proxy User

curl --request PATCH \
  --url https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "clear_proxy_user_acl": true,
  "ip_address_authentications": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "proxy_user_enforce_https": false,
  "proxy_user_is_strict_security": false,
  "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
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"

payload = {
    "clear_proxy_user_acl": True,
    "ip_address_authentications": ["1.1.1.1", "2.2.2.2"],
    "proxy_user_enforce_https": False,
    "proxy_user_is_strict_security": False,
    "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
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    clear_proxy_user_acl: true,
    ip_address_authentications: ['1.1.1.1', '2.2.2.2'],
    proxy_user_enforce_https: false,
    proxy_user_is_strict_security: false,
    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
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'clear_proxy_user_acl' => true,
    'ip_address_authentications' => [
        '1.1.1.1',
        '2.2.2.2'
    ],
    'proxy_user_enforce_https' => false,
    'proxy_user_is_strict_security' => false,
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Private-Key: <api-key>",
    "X-API-Public-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}"

	payload := strings.NewReader("{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Private-Key", "<api-key>")
	req.Header.Add("X-API-Public-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy_user/edit/{proxy_user_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"clear_proxy_user_acl\": true,\n  \"ip_address_authentications\": [\n    \"1.1.1.1\",\n    \"2.2.2.2\"\n  ],\n  \"proxy_user_enforce_https\": false,\n  \"proxy_user_is_strict_security\": false,\n  \"proxy_user_metadata\": {\n    \"internal_customer_id\": \"94266dc6-b29f-4499-a7a8-35232d186706\"\n  },\n  \"proxy_user_mobile_bytes_limit\": 1000000,\n  \"proxy_user_password\": \"newPass1241233\",\n  \"proxy_user_residential_bytes_limit\": 1000000\n}"

response = http.request(request)
puts response.read_body

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

Authorizations

X-API-Private-Key

string

header

required

Private API key for user-level authentication.

X-API-Public-Key

string

header

required

Public API key for user-level authentication.

Headers

Content-Type

string

default:application/json

required

Content type for the request body as application/json.

Path Parameters

proxy_user_id

string

required

ID of the proxy user record to edit.

Body

application/json

The Proxy User details to be edited.

clear_proxy_user_acl

boolean

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_authentications

string[]

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

Example:

["1.1.1.1", "2.2.2.2"]

proxy_user_access_type

enum<string>

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.

Available options:

all,

service_restricted,

proxy_restricted

proxy_user_enforce_https

boolean

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

Example:

false

proxy_user_is_strict_security

boolean

Enable or disable strict security for the Proxy User.

Example:

false

proxy_user_metadata

object

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.

Example:

{
  "internal_customer_id": "94266dc6-b29f-4499-a7a8-35232d186706"
}

proxy_user_mobile_bytes_limit

integer

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

Example:

1000000

proxy_user_password

string

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

Example:

"newPass1241233"

proxy_user_residential_bytes_limit

integer

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

Example:

1000000

Response

200 - application/json

Proxy User Successfully Edited

edited

string[]

List of Proxy User IDs that were successfully edited.

The Proxy User ID.

Example:

["stevejobs"]

message

string

Success message indicating the Proxy User was edited.

Example:

"Proxy User successfully edited."

proxy_user_acl_deleted

string[]

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

The ProxyUserAcl ID.

Example:

["123e4567-e89b-12d3-a456-426614174000"]

Search Proxy Users Delete Proxy User Record

Customer

Proxy

Proxy User

Proxy User ACL

Residential

Residential Availability

Residential Ledger

Mobile

Mobile Availability

Mobile Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Zip Code

Proxy Tester

Authorizations

Headers

Path Parameters

Body

Response