Skip to content

Marketplace User Offering Consents

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-user-offering-consents/ List user offering consents
GET /api/marketplace-user-offering-consents/{uuid}/ Retrieve a user offering consent
POST /api/marketplace-user-offering-consents/ Grant consent to an offering's Terms of Service
PUT /api/marketplace-user-offering-consents/{uuid}/ Update
PATCH /api/marketplace-user-offering-consents/{uuid}/ Partial Update
DELETE /api/marketplace-user-offering-consents/{uuid}/ Delete
Other Actions
POST /api/marketplace-user-offering-consents/{uuid}/revoke/ Revoke consent to Terms of Service

Core CRUD

List user offering consents

Returns a paginated list of Terms of Service consents for the current user. Staff and support users can see all consents.

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

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

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

try {
  const response = await marketplaceUserOfferingConsentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
has_consent boolean Has consent
o array Ordering
offering string Offering URL
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
requires_reconsent boolean Requires reconsent
user string User URL
user_uuid string (uuid) User UUID
version string Version

200 -

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

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean

Returns the details of a specific consent record.

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

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

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

try {
  const response = await marketplaceUserOfferingConsentsRetrieve({
  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)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean

Creates a consent record for the current user and a specific offering. This indicates that the user has accepted the active Terms of Service for that offering. If a consent already exists (even if revoked), it will be reactivated and updated with the current ToS version.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_offering_consent_create_request import UserOfferingConsentCreateRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_create # (2)

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

body_data = UserOfferingConsentCreateRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_user_offering_consents_create.sync(
    client=client,
    body=body_data
)

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

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

201 -

Field Type
offering string (uuid)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-user-offering-consents/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.user_offering_consent_request import UserOfferingConsentRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_update # (2)

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

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

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

try {
  const response = await marketplaceUserOfferingConsentsUpdate({
  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
version string

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-user-offering-consents/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_user_offering_consent_request import PatchedUserOfferingConsentRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_partial_update # (2)

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

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

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

try {
  const response = await marketplaceUserOfferingConsentsPartialUpdate({
  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
version string

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean

Delete

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

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

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

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

Other Actions

Revokes a user's consent to the Terms of Service for an offering. The consent record is marked with a revocation date, and the user may lose access to related resources if consent is required.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/revoke/ \
  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_user_offering_consents import marketplace_user_offering_consents_revoke # (1)

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

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

try {
  const response = await marketplaceUserOfferingConsentsRevoke({
  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)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean