Marketplace Customer Service Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-customer-service-accounts/ |
List Marketplace Customer Service Accounts |
| GET | /api/marketplace-customer-service-accounts/{uuid}/ |
Retrieve |
| POST | /api/marketplace-customer-service-accounts/ |
Create |
| PUT | /api/marketplace-customer-service-accounts/{uuid}/ |
Update |
| PATCH | /api/marketplace-customer-service-accounts/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-customer-service-accounts/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/ |
Rotate api key |
Core CRUD
List Marketplace Customer Service Accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_customer_service_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string | |
customer_uuid |
string (uuid) | |
email |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_customer_service_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_customer_service_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Rotate api key
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |