/clients/set_whitelist


Updates the IP allow list for an API client. The IP allow list specifies the IP addresses that are allowed to access the client; by default, any IP address can access a client. Note that only an owner client can call the /clients/set_whitelist endpoint.

This endpoint includes the following methods:

  • POST

POST


Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String


Base URL

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

https://educationcenter.us-dev.janraincapture.com

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

Examples

Example Request

This command changes the IP allow list for the API client 67890fghij67890fghij to 192.168.0.0/30. That syntax ensures that only devices with the following IP addresses can access the client:

  • 192.168.0.0
  • 192.168.0.1
  • 192.168.0.2
  • 192.168.0.3

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode for_client_id=67890fghij67890fghij \
  --data-urlencode whitelist='["192.168.0.0/30"]' \
  https://my-app.janraincapture.com/clients/set_whitelist
  

      Running this command in Postman

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

ParameterTypeRequiredDescription
for_client_idstring
The ID of the client whose allow list  is to be modified. If this parameter is not present then the owner client's allow list will be modified.
 
whiteliststringYesA JSON array of CIDR addresses that constitute the new allow list for the client. Each value must use the format x.x.x.x/x.
 

Responses

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: 123.4.5.6/7890; value after slash
    must be 32or less",
  "error": "invalid_argument",
  "stat": "error"
}
  

Response Example (application/json)


{
  "stat": "ok"
}