Skip to content

Marketplace Resource Users

Operations Summary

Method Endpoint Description
GET /api/marketplace-resource-users/ List resource users
GET /api/marketplace-resource-users/{uuid}/ Retrieve a resource-user link
POST /api/marketplace-resource-users/ Link a user to a resource
DELETE /api/marketplace-resource-users/{uuid}/ Unlink a user from a resource

List resource users

Returns a paginated list of users associated with resources, including their roles. The list is filtered based on the permissions of the current user. Staff and support users can see all resource-user links. Other users can only see links for resources they have access to.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resource-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.marketplace_resource_users import marketplace_resource_users_list # (1)

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

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

try {
  const response = await marketplaceResourceUsersList({
  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.
resource string Resource URL
resource_uuid string (uuid) Resource UUID
role_name string Role name
role_uuid string (uuid) Role UUID
user_uuid string (uuid) User UUID

200 -

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

Field Type Description
uuid string (uuid)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Returns details of a specific link between a user and a resource, including their role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resource-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.marketplace_resource_users import marketplace_resource_users_retrieve # (1)

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

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

try {
  const response = await marketplaceResourceUsersRetrieve({
  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)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Creates a new association between a user and a resource with a specific role. The user must have permission to manage users for the resource (typically service provider staff or owners).

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-resource-users/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_user_request import ResourceUserRequest # (1)
from waldur_api_client.api.marketplace_resource_users import marketplace_resource_users_create # (2)

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

body_data = ResourceUserRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_resource_users_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUserRequest
  2. API Source: marketplace_resource_users_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceResourceUsersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceResourceUsersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "role": "https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource string (uri) ✓
role string (uri) ✓
user string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Removes the association between a user and a resource, effectively revoking their role on that resource. The user must have permission to manage users for the resource.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-resource-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.marketplace_resource_users import marketplace_resource_users_destroy # (1)

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

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

try {
  const response = await marketplaceResourceUsersDestroy({
  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) ✓

204 - No response body