v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Proxy User

Retrieve Proxy User

Retrieves a specific Proxy User based on the provided ID for the current user's account.

get/public/user/proxy_user/retrieve/{proxy_user_id}

Path parameters

proxy_user_idstring required

ID of the Proxy User to retrieve

Response

Successful Proxy User Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "customer_id": 1955,
    "ip_address_authentications": [
      "17.172.224.47"
    ],
    "mobile_bytes_left": 1,
    "proxy_user_access_type": "all",
    "proxy_user_creation_datetime": "2023-09-28 12:34:56",
    "proxy_user_enforce_https": false,
    "proxy_user_id": "stevejobs",
    "proxy_user_ip_address_authentication_limit": 3,
    "proxy_user_is_default": false,
    "proxy_user_is_deleted": false,
    "proxy_user_is_strict_security": false,
    "proxy_user_last_update_datetime": "2023-09-28 12:34:56",
    "proxy_user_metadata": {
      "resell_order_id": "APPL-9876-5432"
    },
    "proxy_user_mobile_bytes_limit": 134142432,
    "proxy_user_mobile_bytes_used": 31223,
    "proxy_user_password": "apple1984",
    "proxy_user_residential_bytes_limit": 134142432,
    "proxy_user_residential_bytes_used": 31223,
    "residential_bytes_left": 1,
    "restricted_proxy_ids": [
      "d5f6b186-3850-43e5-ac07-55d2ff5eb06e"
    ],
    "restricted_service_ids": [
      "111-230-892"
    ]
  },
  "message": "Proxy User successfully retrieved."
}