ARNPROXY

Extra login scope and options

GET/account/api/v1/extra-logins/options

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionproxy_management
Acceptapplication/json

Parameters

NameTypeDescription
proxy_ids
queryRequired
string1–1000 unique comma-separated proxy IDs without spaces: 12345,12346.

Request example

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/extra-logins/options?proxy_ids=YOUR_PROXY_ID'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response
application/json
{
    "ok": true,
    "data": {
        "proxy_ids": [
            12345
        ],
        "scope_mode": "order_group",
        "group_change_required": true,
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "creation_available": true,
        "unavailable_reason": null,
        "custom_credentials_available": false,
        "username_length": 8,
        "password_length": 10,
        "primary_credentials_modified": false,
        "authorization_scope": "upstream_order",
        "may_affect_other_proxies": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.proxy_idsarrayProxy IDs in the scope visible to this account.
data.proxy_ids[]integerProxy IDs in the scope visible to this account.
data.scope_modestringAuthorization scope. Order/package operations may affect other assignments.
data.group_change_requiredbooleanOperation-specific group change required value; preserve its demonstrated type and consult the behavior notes.
data.revisionstringFreshness fingerprint to copy unchanged to the corresponding write/price confirmation.
data.creation_availablebooleanAvailability under the result’s conditions/permissions, not a stock or provider guarantee.
data.unavailable_reasonstring|nullOperation-specific unavailable reason value; preserve its demonstrated type and consult the behavior notes.
data.custom_credentials_availablebooleanOperation-specific custom credentials available value; preserve its demonstrated type and consult the behavior notes.
data.username_lengthintegerOperation-specific username length value; preserve its demonstrated type and consult the behavior notes.
data.password_lengthintegerOperation-specific password length value; preserve its demonstrated type and consult the behavior notes.
data.primary_credentials_modifiedbooleanOperation-specific primary credentials modified value; preserve its demonstrated type and consult the behavior notes.
data.authorization_scopestringAuthorization scope. Order/package operations may affect other assignments.
data.may_affect_other_proxiesbooleanOther assignments may be affected by the package/order-wide scope.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData source; local records and a live provider lookup are different evidence.

Error response

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

  • Extra logins are separate from the primary delivery login. Creating one does not replace the primary login or delete other extra logins. Read custom_credentials_available, username_length and password_length from the options response before creating credentials.
  • An action may apply to an entire authorization group, such as an order or package, rather than only the selected proxy. Review proxy_ids, authorization_scope and may_affect_other_proxies before continuing. Obtain a new revision if the scope changes.

Search the current language. Close with Esc