Get API Client Credentials

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

This API enables users to fetch an API Client Credentials by ID.

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 fetch

Responses
200

Client

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

null value

tokenDuration
string (ISO-8601 duration)
ExamplePT60M
permission
string
403

Forbidden

forbidden environment
{
  "id": "EW60XA",
  "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": "EW41XA",
  "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": "EW42XA",
  "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