Retrieves a list of API keys

GET 
/v1/apiKeys

Retrieves a list of API keys

Request

Responses

200

Retrieves a list of API keys

application/json

Schema

Schema

items object[]required
List of API keys
Array [
metadata object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set
property name*string
creationTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
labels object
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
property name*string
lastModifiedTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
namestring
Name of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
spec object
API key specification
expirydate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
keystring
Deprecated: API key field will be no longer available
user object
User to whom the API key is created
firstNamestring
First name of user
lastNamestring
Last name of user
uidstring
User uid
status object
API key status
isActiveboolean
API key active state
]

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.159Z",
        "deletionTimestamp": "2023-12-01T21:31:48.159Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.159Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "expiry": "2023-12-01T21:31:48.159Z",
        "key": "string",
        "user": {
          "firstName": "string",
          "lastName": "string",
          "uid": "string"
        }
      },
      "status": {
        "isActive": true
      }
    }
  ]
}

Loading...