Create an API client

post

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

This operation creates a new API client. Optionally, you can automatically assign a credential for the client when you create it. If you choose not to assign the credential automatically, see Create authentication credentials for details. This operation doesn't support service accounts. To create or manage API clients for service accounts, you need to use Identity and Access interface.

Query Params

accountSwitchKey

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

allowAccountSwitch

boolean

Defaults to false

Enables the API client to 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*

canAutoCreateCredential

boolean

Defaults to false

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

clientDescription

string

length ≥ 1

Descriptive label about the API client.

clientName

string

length ≥ 1

Descriptive label for the API client.

clientType

string

enum

required

Specifies the API client's ownership and credential management. CLIENT indicates the creator owns and manages the credentials. USER_CLIENT indicates another user owns the client and manages the credentials.

Allowed:

createCredential

boolean

Defaults to false

With canAutoCreateCredential enabled, setting this to true creates new credentials along with a new API client. The default is false.

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

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The response provides the newly created API client.