Modify an API client

put https://{hostname}/config/{app_id}/clients/{client_id}

Modifies permissions and settings for an API client.

Response

Response body

object

_id

string

required

Unique identifier of the API client.

_secret

string

required

API client secret. The secret serves as the API client password.

_self

string

required

Path used to directly access the client in an API operation.

_settings

string

required

Path used to directly access the client settings in an API operation.

features

array of strings

required

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.

features*

ipWhitelist

array of strings

required

CIDR blocks that comprise the client's IP allowlist. Only IP addresses found on the allowlist can use the client to make API operations. To use any IP address with a client, set the allowlist to 0.0.0.0/0.

ipWhitelist*

name

string

required

Name of the API client.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://hostname/config/app_id/clients/client_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
13
 
1
{
2
  "_id": "3bchk5hsx6v58dkn288nbybmxfyk32u7",
3
  "_secret": "j383npa9g4hfdye9t5es72x8r374tdfh",
4
  "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/3bchk5hsx6v58dkn288nbybmxfyk32u7",
5
  "_settings": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/3bchk5hsx6v58dkn288nbybmxfyk32u7/settings",
6
  "name": "Documentation Login Client",
7
  "features": [
8
    "login_client"
9
  ],
10
  "ipWhitelist": [
11
    "0.0.0.0/0"
12
  ]
13
}

200Successful response