Get permissions for all clients

get https://{hostname}/config/{app_id}/clients

Returns information about the API clients associated with an application.

Responses

Response body

object

_self

string

Configuration URL for the API client.

_id

string

Unique identifier of the API client.

_secret

string

Password assigned to the API client.

_settings

string

Configuration URL for the API client settings.

features

string

Array containing the administrative features to be assigned to the client. Features control access to user records and to management tools. For example, the owner feature provides access to all user records while the login_client feature only allows access to records associated with the authenticated user.

ipWhitelist

string

Arrays containing the IP addresses that comprise the client's IP whitelist. Only IP addresses found on the whitelist can use the client to make API operations. To use any IP address to run API operations, set the whitelist to 0.0.0.0/0.

name

string

Name of the API client.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/config/app_id/clients \
# Add Authorization header to this snippet
3
     --header 'accept: application/json'


xxxxxxxxxx
41
]
1
[
2
  {
3
    "_id": "ay6e3qmucvdyr29hmpvxjdjupe8bcsky",
4
    "_secret": "9956y4tv342e76nj9zub511ufbned98j",
5
    "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ay6e3qmucvdyr29hmpvxjdjupe8bcsky",
6
    "_settings": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ay6e3qmucvdyr29hmpvxjdjupe8bcsky/settings",
7
    "name": "this is a test client",
8
    "features": [
9
      "owner"
10
    ],
11
    "ipWhitelist": [
12
      "0.0.0.0/0"
13
    ]
14
  },
15
  {
16
    "_id": "ed7absqep5rffbmqx89c9mwexqvbnfnk",
17
    "_secret": "hdyebsdtvj5ujjkijk7tfrf968q63ysk9",
18
    "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ed7absqep5rffbmqx89c9mwexqvbnfnk",
19
    "_settings": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/ed7absqep5rffbmqx89c9mwexqvbnfnk/settings",
20
    "name": "Default Login Client",
21
    "features": [
22
      "login_client"
23
    ],
24
    "ipWhitelist": [
25
      "0.0.0.0/0"

200Successful response

401Not authorized.

404Not found.