/clients/list

Get a list of the clients in your application, optionally filtered by client feature. Only the owner client can make this API call.

This endpoint includes the following methods:

  • GET


GET

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

Get a list of clients with the features "direct_access" and "access_issuer".


curl -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode has_features='["direct_access", "access_issuer"]' \
    https://my-app.janraincapture.com/clients/list
  
      Running this command in Postman

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
has_features string A JSON array of feature names; only clients that have at least one of the features in the array will be returned. Allowed values are:
  • owner
  • access_issuer
  • direct_read_access
  • direct_access

Responses

200 OK

Example Error Response


{
  "argument_name": "has_features",
  "request_id": "n7uudpznfbrs79gu",
  "code": 200,
  "error_description": "has_features was not valid for the following reason: the JSON is not syntactically valid",
  "error": "invalid_argument",
  "stat": "error"
}
  

Response Example (application/json)


{
  "results": [
    {
      "whitelist": [
        "0.0.0.0/0"
      ],
      "features": [
        "access_issuer",
        "direct_access",
        "owner"
      ],
      "description": "application owner",
      "client_id": "12345abcde12345abcde",
      "client_secret": "edcba54321edcba54321"
    }
  ],
  "stat": "ok"
}