API
Start typing to search…

Update an API client

put
https://{hostname}/identity-management/v3/api-clients/

This operation updates an API client. This operation doesn't support service accounts. To create or manage API clients for service accounts, you need to use Identity and Access interface.

Path Params
string
required

Unique identifier for each API client. To get this value, run the List API clients operation.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
boolean

Whether the API client can manage more than one account. For details, see Manage many accounts with one API client.

apiAccess
required

The APIs the API client can access.

authorizedUsers
array of strings
required
length ≥ 1

Single username of the API client's valid user. To get this data, run the List authorized users operation.

authorizedUsers*
boolean
Defaults to false

Whether the API client can create a credential for a new API client. The default is false.

string
length ≥ 1

Descriptive label about the API client.

string
length ≥ 1

Descriptive label for the API client.

groupAccess
required

Specifies the API client's group access.

ipAcl
object

Specifies the API client's IP list restriction.

notificationEmails
array of strings
length ≥ 0

Email addresses to notify users of expiring credentials.

notificationEmails
purgeOptions
object

Configures the API client for access to the Fast Purge API. Provide it only if the apis object includes an apiName of CCU APIs or if allAccessibleApis is set to true.

Response

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago