Retrieves a list of API keys

GET 
/v1/apiKeys

Retrieves a list of API keys

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 is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

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

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

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": "2024-07-27T05:12:13.122Z",
        "deletionTimestamp": "2024-07-27T05:12:13.122Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-27T05:12:13.122Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "expiry": "2024-07-27T05:12:13.122Z",
        "key": "string",
        "user": {
          "firstName": "string",
          "lastName": "string",
          "uid": "string"
        }
      },
      "status": {
        "isActive": true
      }
    }
  ]
}

Loading...