Update API Client Credentials

  • Updated on Jan 6, 2025
  • Published on Dec 4, 2023
  • 1 minute(s) read
Prev Next
Put
/env-mgmt/1.0/api-key/clients/{id}

This API enables users to update API Client Credentials associated with a specific Tenant or Environment.

Notice

Accessing the Policy Management APIs is through a dedicated domain/URL according to your PlainID Tenant Location:
`https://api.{REGION}.plainid.io`

United States (US) - https://api.us1.plainid.io
Canada (US) - https://api.ca1.plainid.io
Europe (US) - https://api.eu1.plainid.io

Replace{REGION} with your PlainID Tenant region (e.g. us1, eu1, ca1, etc.).


cURL Sample Guidelines

In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.

Security
HTTP
Type bearer

For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123

Path parameters
id
stringRequired

Client ID to update.

Body parameters
Sample Update environment admin
{
  "ownerId": "b0e1f961-2061-4f83-8392-b5aa19fed0c1",
  "ownerType": "ENVIRONMENT",
  "name": "Name7",
  "description": "Name7 Description",
  "tokenDuration": "PT1440M",
  "permission": "ADMIN"
}
Sample Update environment viewer
{
  "ownerId": "b0e1f961-2061-4f83-8392-b5aa19fed0c1",
  "ownerType": "ENVIRONMENT",
  "name": "Name8",
  "description": "Name8 Description",
  "tokenDuration": "PT1440M",
  "permission": "VIEWER"
}
Sample Update tenant admin
{
  "ownerId": null,
  "ownerType": "TENANT",
  "name": "Name9",
  "description": "Name9 Description",
  "tokenDuration": "PT1440M",
  "permission": "ADMIN"
}
object
name
string Required

Client Name

Max length100
description
string Required

Client Description

Max length200
tokenDuration
string (ISO-8601 duration) Required

Client Token Duration

ExamplePT60M
Responses
200

Client updated

id
string
ownerId
string (UUID)
ownerType
string
name
string
description
string
secret
string

Null value. Secret not included in the response for security reasons.

tokenDuration
string (ISO-8601 duration)
permission
string
400

Client already exists

client already exists
{
  "id": "EW59XA",
  "status": 400,
  "name": "clientAlreadyExists",
  "message": "client {name} already exists"
}
Expand All
object
code
string
id
string
status
integer
name
string
message
string
args
object
path
string
403

Forbidden

forbidden environment
{
  "id": "EW56XA",
  "status": 403,
  "name": "forbiddenEnvironment",
  "message": "operation get for resource Environment {ownerId} is not allowed because the current user does not have the appropriate permissions"
}
forbidden tenant
{
  "id": "EW57XA",
  "status": 403,
  "name": "forbiddenTenant",
  "message": "operation get for resource Environment {ownerId} is not allowed because the current user does not have the appropriate permissions"
}
Expand All
object
code
string
id
string
status
integer
name
string
message
string
args
object
path
string
404

Client not found

client not found
{
  "id": "EW58XA",
  "status": 404,
  "name": "clientNotFoundError",
  "message": "Client {name} not found"
}
Expand All
object
code
string
id
string
status
integer
name
string
message
string
args
object
path
string