Skip to content

Keycloak Groups

Operations Summary

Method Endpoint Description
GET /api/keycloak-groups/ List Keycloak Groups
GET /api/keycloak-groups/{uuid}/ Retrieve

List Keycloak Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-groups/ \
  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.keycloak_groups import keycloak_groups_list # (1)

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

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

try {
  const response = await keycloakGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string
scope_type string
scope_uuid string (uuid)

200 -

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

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
scope_type string
scope_uuid string (uuid) UUID of the cluster or project
scope_name string Get the name of the cluster or project
role string (uri)
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-groups/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.keycloak_groups import keycloak_groups_retrieve # (1)

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

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

try {
  const response = await keycloakGroupsRetrieve({
  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
uuid string (uuid)
url string (uri)
name string
backend_id string
scope_type string
scope_uuid string (uuid) UUID of the cluster or project
scope_name string Get the name of the cluster or project
role string (uri)
created string (date-time)
modified string (date-time)