pydo.kubernetes.get_cluster_user()
Generated on 25 November 2024
from pydo version v0.6.0
Description
To show information the user associated with a Kubernetes cluster, send a GET
request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.
Parameters
| Name |
Type |
Required |
Description |
Default Value |
cluster_id |
string |
True |
A unique ID that can be used to reference a Kubernetes cluster. |
|
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
resp = client.kubernetes.get_cluster_user(cluster_id="da8fda8")
Responses
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.
The response will be a JSON object with a key called kubernetes_cluster_user
containing the username and in-cluster groups that it belongs to.
Click to expand an example response.
{
"kubernetes_cluster_user": {
"username": "[email protected]",
"groups": [
"k8saas:authenticated"
]
}
}
Unauthorized
Click to expand an example response.
{
"id": "unauthorized",
"message": "Unable to authenticate you."
}
The resource was not found.
Click to expand an example response.
{
"id": "not_found",
"message": "The resource you requested could not be found."
}
API Rate limit exceeded
Click to expand an example response.
{
"id": "too_many_requests",
"message": "API Rate limit exceeded."
}
Server error.
Click to expand an example response.
{
"id": "server_error",
"message": "Unexpected server-side error"
}
Unexpected error
Click to expand an example response.
{
"id": "example_error",
"message": "some error message"
}