Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Proxy User

Search Proxy Users

Search Proxy Users on the customer account using various filters.

get/public/user/proxy_user/search

Query parameters

proxy_user_idstring

ID of the Proxy User

proxy_user_passwordstring

Password of the Proxy User

proxy_user_ip_address_authentication_limitinteger

IP Address authentication limit of the Proxy User (supports min_/max_)

proxy_user_is_deletedboolean

Whether the Proxy User is deleted (true/false)

proxy_user_access_typestring

Access control type for the proxy user (all/service_restricted/proxy_restricted)

proxy_user_is_strict_securityboolean

Whether the Proxy User has strict security (true/false)

proxy_user_is_defaultboolean

Whether the Proxy User is default (true/false)

proxy_user_creation_datetimestring date-time

Creation datetime of the Proxy User (supports min_/max_)

proxy_user_last_update_datetimestring date-time

Last update datetime of the Proxy User (supports min_/max_)

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Proxy User search

item_countinteger

Total number of Proxy User items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Proxy User items returned per page.

total_countinteger

Total of Proxy User items that match the search filter.

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"
      ]
    }
  ],
  "item_count": 1,
  "message": "Proxy User search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}