Change the IP whitelist for a target client, overwriting the previous whitelist. Only the client with the owner feature may make this API call. If the owner client sets the whitelist for itself, the whitelist must allow access from the IP address making the call. All new clients begin with a default whitelist of [""] (meaning that all IP addresses are allowed).

This endpoint includes the following methods:

  • POST



This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:


Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:


Example Request

Change the IP whitelist for the client with the ID value 67890fghij67890fghij to an array that includes the IP address

curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode for_client_id=67890fghij67890fghij \
    --data-urlencode whitelist='[""]'\
      Running this command in Postman

Authorized Clients

  • owner


  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string The ID of the client whose whitelist is to be modified. If this parameter is not present then the owner client's whitelist will be modified.
whitelist string Yes A JSON array of CIDR addresses that constitute the new whitelist for the client. Each value must use the format x.x.x.x/x.


200 OK

Example Error Response

  "argument_name": "whitelist",
  "request_id": "g8snkpqubwkd7kzh",
  "code": 200,
  "error_description": "whitelist was not valid for the following
    reason: invalid cidr address:; value after slash
    must be 32or less",
  "error": "invalid_argument",
  "stat": "error"

Response Example (application/json)

  "stat": "ok"