Contents x
    List API Client Credentials
    • 12 Dec 2023
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    List API Client Credentials

    • Updated on 12 Dec 2023
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    Get
    /env-mgmt/1.0/api-key/clients

    This API enables users to get a list of Client Credentials through a 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.).
    Security
    Http
    Type bearer
    For more details about Management API Authentication, check out the Management APIs Authentication Article
    Provide your bearer token in the Authorization header when making requests to protected resources.
    Example: `Authorization: Bearer 123`
    Query parameters
    filter
    object

    Client Owner is the Environment ID. The Environment ID can be found under the Details tab in the Environment Settings. If this is for a Tenant Admin, input null or - in the ownerId field.

    sort
    string
    Valid values[ "ASC", "DESC" ]
    limit
    number
    Maximum50
    Minimum1
    Default"50"
    offset
    number
    Minimum0
    Default"0"
    Responses
    200

    Client

    Expand All
    data
    Array of object
    object
    id
    string
    ownerId
    string (UUID)
    ownerType
    string
    name
    string
    description
    string
    secret
    string

    Null value

    tokenDuration
    string (ISO-8601 duration)
    permission
    string
    total
    integer
    limit
    integer
    offset
    integer
    400

    Missing required filter parameter: ownerId

    missingOwnerId
    {
  "id": {
    "type": "string",
    "example": "EW55XA",
    "description": "ID for Error Instance"
  },
  "status": {
    "enum": [
      "400"
    ]
  },
  "name": {
    "type": "string",
    "enum": [
      "MissingRequiredFilterParameterError"
    ]
  },
  "message": {
    "type": "string",
    "enum": [
      "Missing required filter parameter: ownerId"
    ]
  }
}
    Expand All
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    403

    Forbidden

    forbidden environment
    {
  "id": {
    "type": "string",
    "example": "EW25XA",
    "description": "ID for Error Instance"
  },
  "status": {
    "enum": [
      "403"
    ]
  },
  "name": {
    "type": "string",
    "enum": [
      "forbiddenEnvironment"
    ]
  },
  "message": {
    "type": "string",
    "enum": [
      "operation get for resource Environment {ownerId} is not allowed because the current user does not have the appropriate permissions"
    ]
  }
}
    forbidden tenant
    {
  "id": {
    "type": "string",
    "example": "EW53XA",
    "description": "ID for Error Instance"
  },
  "status": {
    "enum": [
      "403"
    ]
  },
  "name": {
    "type": "string",
    "enum": [
      "forbiddenTenant"
    ]
  },
  "message": {
    "type": "string",
    "enum": [
      "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": {
    "type": "string",
    "example": "EW54XA",
    "description": "ID for Error Instance"
  },
  "status": {
    "enum": [
      "404"
    ]
  },
  "name": {
    "type": "string",
    "enum": [
      "clientNotFoundError"
    ]
  },
  "message": {
    "type": "string",
    "enum": [
      "Client {name} not found"
    ]
  }
}
    Expand All
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    Was this article helpful?
    What's Next