/clients/clear_whitelist

Clears the IP whitelist for a target client, resetting it to the default value that allows all IP addresses. Only the owner client may make this API call. The default whitelist is ["0.0.0.0/0"] (all IP addresses are allowed).

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 Janrain Capture domain; for example:

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

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

Examples

Example Request

Clears the whitelist for a client with the ID value 67890fghij67890fghij.


curl -X POST \
  -H "Authorization: Basic aW1fYV...NfbXk="\
  --data-urlencode for_client_id=67890fghij67890fghij \
  https://my-app.janraincapture.com/clients/clear_whitelist"stat": "ok"
  
      Running this command in Postman

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string The ID for the client whose whitelist will be cleared. If this parameter is not included, the whitelist for the owner client will be cleared.
 

Responses

200 OK

Example Error Response


{
  "argument_name": "for_client_id",
  "request_id": "ytjjh5pqjhkwyhdr",
  "code": 200,
  "error_description": "for_client_id was not valid for the following
    reason: for_client_id isnot avalid id",
  "error": "invalid_argument",
  "stat": "error"
}
  

Response Example (application/json)


{
  "stat": "ok"
}