Accounts API

Use the Accounts API to manage accounts, users, and related entities programmatically.

The Accounts API enables you to programmatically access and manage key account-related data within the Marketplace Platform.

It provides secure endpoints that allow you to perform operations such as creating, updating, and retrieving information about accounts, users, user groups, licensees, sellers, and API tokens.

Additionally, the API supports retrieving a list of available modules within the platform and managing ERP system links.

Try APIDownload API

Core Concepts

The Accounts API is built around the following core resources:

• Account - Represents a client account, vendor account, or operations account.

• Account user - Represents an account user.

• API token - Represents an authentication token object.

• Buyer - Represents entities that engage in commercial activities and are the recipients of invoices issued by SoftwareOne.

• Cloud tenant - Represents a cloudTenant object in the Marketplace.

• ERP link - Represents a connection between the buyer object and the seller object in the Marketplace.

• Licensee - Represents entities that consume the software products or services procured by the buyer.

• Module - Represents modules available in the platform, for example Marketplace.

• Seller - Represents SoftwareOne entities (for example, SoftwareOne Canada) that buy software solutions from vendors and sell those solutions to clients.

• User - Represents users who can sign in to the platform using their credentials and perform operations associated with their permissions.

• User group - Represents a userGroup object in the Marketplace.

Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Accounts

Capability	Public	Client	Vendor	Operations
List accounts	❌	✅	✅	✅
Get a specific account	❌	✅	✅	✅
Create account	❌	❌	❌	✅
Update account details	❌	✅	✅	✅
Disable account	❌	❌	✅	✅
Enable account	❌	❌	❌	✅
Activate account	❌	❌	❌	✅
Validate account	❌	❌	❌	✅
Deactivate account	❌	❌	❌	✅
Get an account icon	✅	❌	❌	❌
Upload an icon	❌	✅	✅	✅

Account Users

Capability	Client	Vendor	Operations
List all account users	✅	✅	✅
Get account user	✅	✅	✅
Create account user	✅	✅	✅
Delete account user	✅	✅	✅
Accept user invitation	✅	✅	✅
Resend user account invitation	✅	✅	✅
Send new invitation	✅	✅	✅
Assign user to the user group	✅	✅	✅
Update user to group assignment	✅	✅	✅
Remove user from the user group	✅	✅	✅

API tokens

Capability	Client	Vendor	Operations
List API tokens	✅	✅	✅
Get API token	✅	✅	✅
Create API token	✅	✅	✅
Delete API token	✅	✅	✅
Update API token	✅	✅	✅
Disable API token	✅	✅	✅
Enable API token	✅	✅	✅

Buyers

Capability	Public	Client	Vendor	Operations
List buyers	❌	✅	❌	✅
Get a specific buyer	❌	✅	❌	✅
Create buyer	❌	❌	❌	✅
Update buyer	❌	✅	❌	✅
Disable buyer	❌	✅	❌	✅
Enable buyer	❌	❌	❌	✅
Validate buyer	❌	❌	❌	✅
Delete buyer	❌	❌	❌	✅
Deactivate buyer	❌	❌	❌	✅
Synchronize buyer	❌	❌	❌	✅
Buyer transfer	❌	❌	❌	✅
Buyer transfer details	❌	❌	❌	✅
Get buyer icon	✅	❌	❌	❌
Upload an icon	❌	✅	✅	✅

Cloud tenants

Capability	Client	Vendor	Operations
List cloud tenants	❌	❌	✅
Get cloud tenant	❌	❌	✅
Create cloud tenant	❌	❌	✅
Delete cloud tenant	❌	❌	✅
Update cloud tenant	❌	❌	✅

Sellers

Capability	Public	Client	Vendor	Operations
List sellers	❌	✅	❌	✅
Get seller	❌	✅	❌	✅
Create seller	❌	❌	❌	✅
Update seller	❌	❌	❌	✅
Activate seller	❌	❌	❌	✅
Deactivate seller	❌	❌	❌	✅
Disable seller	❌	❌	❌	✅
Enable seller	❌	❌	❌	✅
Delete seller	❌	❌	❌	✅
Get seller icon	✅	❌	❌	❌
Upload an icon	❌	❌	❌	✅

ERP Link

Capability	Public	Client	Vendor	Operations
List ERP links	❌	✅	❌	✅
Get ERP link	❌	✅	❌	✅
Update ERP link	❌	❌	❌	✅
Unblock ERP link	❌	❌	❌	✅
Block ERP link	❌	❌	❌	✅
Get an ERP link icon	✅	❌	❌	❌
Upload an icon	❌	❌	❌	✅

Licensees

Capability	Public	Client	Vendor	Operations
List licensees	❌	✅	❌	✅
Get licensee	❌	✅	❌	✅
Create licensee	❌	✅	❌	✅
Update licensee	❌	✅	❌	✅
Disable licensee	❌	✅	❌	✅
Enable licensee	❌	✅	❌	✅
Delete licensee	❌	❌	❌	✅
Get a licensee icon	✅	❌	❌	❌
Upload an icon	❌	✅	✅	✅

Modules

Capability	Client	Vendor	Operations
List modules	❌	❌	✅

Users

Capability	Client	Vendor	Operations
List users	✅	✅	✅
Get user	✅	✅	✅
Check SSO configuration for the user	✅	✅	✅
Get the accounts collections for the user	❌	❌	✅
Update user	✅	✅	✅
Set user password	✅	✅	✅
Block user	❌	❌	✅
Unblock user	❌	❌	✅

User Groups

Capability	Client	Vendor	Operations
List all user groups	✅	✅	✅
Get user group	✅	✅	✅
Create user group	✅	✅	✅
Update user group	✅	✅	✅
Delete user group	✅	✅	✅