Skip to content

Marketplace Offering User Roles

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-user-roles/ List Marketplace Offering User Roles
GET /api/marketplace-offering-user-roles/{uuid}/ Retrieve
POST /api/marketplace-offering-user-roles/ Create
PUT /api/marketplace-offering-user-roles/{uuid}/ Update
PATCH /api/marketplace-offering-user-roles/{uuid}/ Partial Update
DELETE /api/marketplace-offering-user-roles/{uuid}/ Delete

List Marketplace Offering User Roles

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-roles/ \
  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_offering_user_roles import marketplace_offering_user_roles_list # (1)

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

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

try {
  const response = await marketplaceOfferingUserRolesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

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

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-roles/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_offering_user_roles import marketplace_offering_user_roles_retrieve # (1)

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

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

try {
  const response = await marketplaceOfferingUserRolesRetrieve({
  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
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-offering-user-roles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-user-role" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_role_request import OfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_create # (2)

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

body_data = OfferingUserRoleRequest(
    name="my-awesome-marketplace-offering-user-role",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_user_roles_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUserRolesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-offering-user-role",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
offering string (uri) ✓
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

201 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-user-role" \
  offering="https://api.example.com/api/offering/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.offering_user_role_request import OfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_update # (2)

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

body_data = OfferingUserRoleRequest(
    name="my-awesome-marketplace-offering-user-role",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_user_roles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUserRolesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-offering-user-role",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
offering string (uri) ✓
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

200 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_user_role_request import PatchedOfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_partial_update # (2)

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

body_data = PatchedOfferingUserRoleRequest()
response = marketplace_offering_user_roles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceOfferingUserRolesPartialUpdate({
  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) ✓
Field Type Required Description
name string
offering string (uri)
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

200 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-user-roles/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_offering_user_roles import marketplace_offering_user_roles_destroy # (1)

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

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

try {
  const response = await marketplaceOfferingUserRolesDestroy({
  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