Lock an API client

put

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

This operation locks an API client, preventing it from making requests on the network. You can't use the API client while it's locked. To unlock a client, run the Unlock an API client operation.

Response

Response body

object

accessToken

string

required

length ≥ 1

Part of the client secret that identifies your API client and lets you access applications and resources. It helps form the unique hostname the client uses to call the API. Tokens are unique per client.

activeCredentialCount

integer

required

≥ 0

Number of credentials active for the API client. When the count is zero, you can delete the API client without interruption.

allowAccountSwitch

boolean

required

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

authorizedUsers

array of strings

required

length ≥ 1

Usernames of the API client's valid users. The CLIENT and USER_CLIENT client type have only a single user, and SERVICE_ACCOUNTS can have many.

authorizedUsers*

canAutoCreateCredential

boolean

Defaults to false

Whether the API client can create a credential for a new API client.

clientDescription

string

required

length ≥ 1

Descriptive label about the API client.

clientId

string

required

length ≥ 1

Unique identifier for each API client.

clientName

string

required

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. SERVICE_ACCOUNT indicates only authorizedUsers can manage the client's credentials. The SERVICE_ACCOUNT type doesn't apply to create and update API clients operations.

CLIENT USER_CLIENT SERVICE_ACCOUNT

createdBy

string

required

length ≥ 1

The user who created the API client.

createdDate

date-time

required

ISO 8601 timestamp indicating when the API client was created.

isLocked

boolean

required

Whether the API client is locked, preventing it from making requests on the network.

notificationEmails

array of strings

required

length ≥ 0

Email addresses to notify users of expiring credentials.

notificationEmails*

serviceConsumerToken

string

required

length ≥ 1

Unique identifier for the service hostname.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://hostname/identity-management/v3/api-clients/clientId/lock \
3
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "accessToken": "akaa-ly55myu4fbtajqck-o7oubkbiytbjxywe",
3
  "activeCredentialCount": 1,
4
  "allowAccountSwitch": false,
5
  "authorizedUsers": [
6
    "jsmith"
7
  ],
8
  "clientDescription": "Provides access to the reporting data.",
9
  "clientId": "xfz2n5d43mogkdim",
10
  "clientName": "report_data",
11
  "clientType": "CLIENT",
12
  "createdBy": "jsmith",
13
  "createdDate": "2022-05-13T20:04:35.000Z",
14
  "isLocked": true,
15
  "notificationEmails": [
16
    "jsmith@example.com"
17
  ],
18
  "serviceConsumerToken": "akaa-lb77cyyf3guivns3-sxmd4sims2mihn67"
19
}

200The response provides the locked API client.