Skip to content

Rancher Users

Operations Summary

Method Endpoint Description
GET /api/rancher-users/ List Rancher Users
GET /api/rancher-users/{uuid}/ Retrieve

List Rancher Users

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_users import rancher_users_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_users_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherUsersList } from 'waldur-js-client';

try {
  const response = await rancherUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid) Cluster UUID
is_active boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings_uuid string (uuid)
user_full_name string User full name contains
user_username string
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
cluster_roles array of objects
cluster_roles.cluster string (uri)
cluster_roles.role string (uri)
cluster_roles.cluster_name string
cluster_roles.cluster_uuid string (uuid)
project_roles array of objects
project_roles.project string (uri)
project_roles.role string (uri)
project_roles.project_name string
project_roles.project_uuid string (uuid)
settings string (uri)
is_active boolean
user_name string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_users import rancher_users_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherUsersRetrieve } from 'waldur-js-client';

try {
  const response = await rancherUsersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
cluster_roles array of objects
cluster_roles.cluster string (uri)
cluster_roles.role string (uri)
cluster_roles.cluster_name string
cluster_roles.cluster_uuid string (uuid)
project_roles array of objects
project_roles.project string (uri)
project_roles.role string (uri)
project_roles.project_name string
project_roles.project_uuid string (uuid)
settings string (uri)
is_active boolean
user_name string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string