lexicons and xrpc
lexicon
com.publicdomainrelay.temp.cluster.listKubeconfigs
The gateway lists the kubeconfigs issued for the named cluster of the calling account: one ClusterClientCertificate record per kubeconfig, revoked ones included. The account is the verified token's iss. No key or certificate is returned.
definitions: #kubeconfigItem
parameters
| parameter | type | description |
|---|---|---|
name * | string | The cluster label of the calling account. |
output
| field | type | description |
|---|---|---|
kubeconfigs * | array of #kubeconfigItem |
errors
| error | description |
|---|---|
InvalidRequest | The request is malformed. |
Unauthorized | Missing or invalid service-auth token. |
ClusterNotFound | This account has no cluster of that name. |
ClusterUnavailable | 503: the gateway could not resolve the token issuer's signing key in time. Retry. |
InternalError | 500: a failure the gateway maps to no named error. |
#kubeconfigItem object
| field | type | description |
|---|---|---|
serial * | string | The client certificate serial, lowercase hex. revokeKubeconfig takes it. |
createdAt | string datetime | |
notAfter * | string | The certificate's NotAfter (RFC 3339). |
noExpiry | boolean | Issued with noExpiry (or ttlSeconds 0): it ends only by revocation. |
revoked | boolean | |
revokedAt | string |
used in
no page of these docs names it yet.
raw schema: lexicons/com/publicdomainrelay/temp/cluster/listKubeconfigs.json
{
"lexicon": 1,
"id": "com.publicdomainrelay.temp.cluster.listKubeconfigs",
"defs": {
"main": {
"type": "query",
"description": "The gateway lists the kubeconfigs issued for the named cluster of the calling account: one ClusterClientCertificate record per kubeconfig, revoked ones included. The account is the verified token's iss. No key or certificate is returned.",
"parameters": {
"type": "params",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The cluster label of the calling account."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"kubeconfigs"
],
"properties": {
"kubeconfigs": {
"type": "array",
"items": {
"type": "ref",
"ref": "#kubeconfigItem"
}
}
}
}
},
"errors": [
{
"name": "InvalidRequest",
"description": "The request is malformed."
},
{
"name": "Unauthorized",
"description": "Missing or invalid service-auth token."
},
{
"name": "ClusterNotFound",
"description": "This account has no cluster of that name."
},
{
"name": "ClusterUnavailable",
"description": "503: the gateway could not resolve the token issuer's signing key in time. Retry."
},
{
"name": "InternalError",
"description": "500: a failure the gateway maps to no named error."
}
]
},
"kubeconfigItem": {
"type": "object",
"required": [
"serial",
"notAfter"
],
"properties": {
"serial": {
"type": "string",
"description": "The client certificate serial, lowercase hex. revokeKubeconfig takes it."
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"notAfter": {
"type": "string",
"description": "The certificate's NotAfter (RFC 3339)."
},
"noExpiry": {
"type": "boolean",
"description": "Issued with noExpiry (or ttlSeconds 0): it ends only by revocation."
},
"revoked": {
"type": "boolean"
},
"revokedAt": {
"type": "string"
}
}
}
}
}