Skip to content

User Permissions

Operations Summary

Method Endpoint Description
GET /api/user-permissions/ List user permissions
GET /api/user-permissions/{uuid}/ Get permission details

List user permissions

Get a list of all permissions for the current user. Staff and support users can view all user permissions. The list can be filtered by user, scope, role, etc.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permissions/ \
  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.user_permissions import user_permissions_list # (1)

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

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

try {
  const response = await userPermissionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
expiration_time string (date-time)
full_name string User full name contains
modified string (date-time) Modified after
native_name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string Role name contains
role_uuid string (uuid) Role UUID
scope_name string Scope name
scope_type string Scope type
scope_uuid string Scope UUID
user string (uuid)
user_slug string User slug contains
user_url string
username string

200 -

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

Field Type
user_uuid string (uuid)
user_name string
user_slug string
created string (date-time)
expiration_time string (date-time)
created_by_full_name string
created_by_username string
role_name string
role_description string
role_uuid string (uuid)
scope_type string
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string

Get permission details

Retrieve the details of a specific user permission grant by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permissions/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.user_permissions import user_permissions_retrieve # (1)

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

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

try {
  const response = await userPermissionsRetrieve({
  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
user_uuid string (uuid)
user_name string
user_slug string
created string (date-time)
expiration_time string (date-time)
created_by_full_name string
created_by_username string
role_name string
role_description string
role_uuid string (uuid)
scope_type string
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string