1 of 72

Accounts API

Account

Account Object

The account object represents an individual account on the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary account identifier.

Example: "ACC-1671-0642"

href

string

Relative reference to object on API.

Example: "/v1/accounts/accounts/ACC-1671-0642"

type

string

Type of the account (Client, Vendor, Operations)

Example: "Client"

status

string

Status of the account (Enabled, Active, Disabled)

Example: "Enabled"

name

string

Account name.

Example: "Stark Industries"

description

string

Account description.

Example: "Our company account"

externalId

string

External identifier - Customer Discount Group number.

Example: "WW-1001111"

externalName

string

External identifier - Customer Discount Group name.

Example: "Stark Industries"

serviceLevel

string

Service level offered to the account (Essential, Elite, DSC)

Example: "Elite"

address

object

Address of the company.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

icon

string

Relative path to account logo.

Example: "/static/accounts/ACC-1671-0642/logo.png"

website

string

Path to company’s website.

Example: "https://www.example.com"

technicalSupportEmail

string

Technical support email for some corner cases.

Example: "user@example.com"

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, or Activated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } }
}

groups

Example

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com"  
}

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com",
  "groups": [
		{
			"id": "UGR-9354-3382",
			"href": "/user-groups/UGR-9354-3382",
			"name": "Administrators",
			"description": "Manages administrative tasks and resources within an organization.",
			"logo": null,
			"isDefault": true
		}
  ],
  {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}

List Accounts

Create Account

Create a new Client or Vendor Account object.

Enable Account

Enable the previously disabled Account object.

When enabled, the account status will change to Active if the account has ExternalId assigned or Enabled otherwise.

Disable Account

Disable the Account object. Disabling prevents users from signing in

Activate Account

Activate the previously enabled Account object.

Get Account

Get a single Account object by ID.

Update Account

Update the Account object.

Validate Account

Validate the Account object.

Get List of External Buyers

Gets a list of external Buyer objects that can be added to Account

Get Account Icon

Buyer

Buyer Object

The buyer object represents an individual buyer in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary buyer identifier.

Example: "BUY-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/buyers/BUY-1234-1234"

status

string

Status: Enabled, Active, Disabled, Deleted

name

string

Buyer's name.

Example: "Stark Industries"

icon

string

Relative path to buyer’s logo.

Example: "/static/accounts/BUY-1234-1234/logo.png"

externalIds

BuyerExternalIdsObject

External identifier.

Example:

{
 "erpCompanyContact": "WW-CON-123456",
 "erpCustomer": "WW-SCU-123456"
}

address

object

Address of the buyer.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

taxId

string

Buyer's tax ID.

Example: "12-34567890"

account

Buyer’s account object.

sellers

contact

object

Contact person details.

Example:

{
	"name": "Will Smith",
	"firstName": "Will",
	"lastName": "Smith",
	"email": "will.smith@adastraflex.com",
	"phone": null,
	"user": {
		"id": "USR-0000-0001",
		"href": "/users/USR-0000-0001",
		"icon": null,
		"name": "Will Smith"
	}
}

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, Activated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "deleted": { "at": "...", "by": { } }
}

Example

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null
	},
	"externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"name": "Stark Industries"
}

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null,
		"user": {
			"id": "USR-0000-0001",
			"href": "/users/USR-0000-0001",
			"icon": null,
			"invited": "2024-02-03T11:34:15.381Z",
			"joined": "2024-02-04T12:34:15.381Z",
			"lastLogin": "2024-02-05T13:34:15.381Z",
			"name": "Will Smith"
		}
	},
    "externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"account": {
		"id": "ACC-5563-4382",
		"href": "/accounts/accounts/ACC-5563-4382",
		"type": "Client",
		"status": "Active",
		"icon": null,
		"name": "AdAstraflexx"
	},
	"name": "Stark Industries",
	"sellers": [
		{
			"id": "SEL-1299-2079",
			"href": "/accounts/sellers/SEL-1299-2079",
			"externalId": "SWO_CH",
			"name": "SoftwareOne AG"
		}
	],
	"audit": {
		"created": {
			"at": "2023-12-14T13:44:20.896Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2024-01-06T19:04:16.692Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		}
	}
}

List Buyers

Get the Buyers collection.

Create Buyer

Create a new Buyer object for the client account.

Enable Buyer

Enable a previously disabled Buyer object.

When enabled, the buyer status will change to Active if the buyer has ExternalId assigned or Enabled otherwise.

Disable Buyer

Disable the Buyer object. Disabled buyers cannot be used in transactions.

Get Buyer

Get a single Buyer object by ID.

Update Buyer

Update the Buyer object. You can only update the logo and contact fields only.

Delete Buyer

Delete the Buyer object.

Validate Buyer

Validate a Buyer object.

Seller

Seller Object

The seller object represents a seller in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary seller identifier.

Example: "SEL-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/sellers/SEL-1234-1234"

status

string

Status: Active , Disabled, Offline , Deleted

name

string

Seller's name.

Example: "SoftwareOne USA"

icon

string

Relative path to seller’s logo.

Example: "/static/accounts/SEL-1234-1234/logo.png"

externalId

string

External identifier.

Example: "WW-CON-123456"

address

object

Address of the seller.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

currency

string

buyers

audit

object

Possible audit events: Created, Updated, Activated, Disabled, Deactivated, or Deleted

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "deactivated": { "at": "...", "by": { } },
  "deleted": { "at": "...", "by": { } }
}

Example

{
	"id": "SEL-7295-4834",
	"href": "/accounts/sellers/SEL-7295-4834",
	"externalId": "SWO_CH",
	"status": "Active",
	"icon": null,
	"currency": "USD",
	"address": {
		"addressLine1": "Some street",
		"addressLine2": null,
		"postCode": "P0S C0D3",
		"city": "Some city",
		"state": "SS",
		"country": "CH"
	},
	"name": "SoftwareOne AG"
}

{
	"id": "SEL-7295-4834",
	"href": "/accounts/sellers/SEL-7295-4834",
	"externalId": "SWO_CH",
	"status": "Active",
	"icon": null,
	"currency": "USD",
	"address": {
		"addressLine1": "Some street",
		"addressLine2": null,
		"postCode": "P0S C0D3",
		"city": "Some city",
		"state": "SS",
		"country": "CH"
	},
	"name": "SoftwareOne AG",
	"buyers": [
		{
			"id": "BUY-2321-7707",
			"href": "/accounts/buyers/BUY-2321-7707",
			"name": "My first buyer"
		}
	],
	"audit": {
		"created": {
			"at": "2023-12-14T14:19:13.410Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:59:55.933Z",
				"joined": "2024-02-04T12:59:55.933Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2024-01-24T09:33:09.073Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:59:55.933Z",
				"joined": "2024-02-04T12:59:55.933Z",
				"lastLogin": "2024-02-05T13:59:55.933Z",
				"name": "Will Smith"
			}
		}
	}
}

List Sellers

Get the Sellers collection.

Get Seller

Get a single Seller object by ID.

Create Seller

Create a new Seller object.

Update Seller

Update the seller object, except the seller status. Use the disable, activate, deactivate, and delete endpoints to manage the status.

Activate Seller

Activate a previously deactivated or disabled seller.

When activated, the status changes from Offline or Disabled to Active.

Deactivate Seller

Deactivate a seller.

When a seller is deactivated, the status changes from Active to Offline.

Disable Seller

Disable or deactivate the seller object.

When disabled, the status changes from Active to Disabled. Disabled sellers cannot be used in transactions.

Delete Seller

Delete the seller object. When deleted, the status changes from Active to Deleted.

Licensee

Licensee Object

The licensee object represents a licensee in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary licensee identifier.

Example: "LCE-1234-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/licensees/LIC-1234-1234-1234"

status

string

Status: Enabled

Active, Disabled, Deleted

name

string

Licensee's name.

Example: "Stark Industries Finance Dept"

icon

string

Relative path to licensee’s logo.

Example: "/static/accounts/LIC-1234-1234-1234/logo.png"

externalId

string

External identifier .

Example: "WW-CON-12345678"

useBuyerAddress

boolean

Defines whether address should be copied from buyer.

Example: "true"

address

object

Address of the licensee.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

description

string

Description of the licensee.

contact

object

Contact person details.

Example:

{
	"name": "Will Smith",
	"firstName": "Will",
	"lastName": "Smith",
	"email": "will.smith@adastraflex.com",
	"phone": null,
	"user": {
		"id": "USR-0000-0001",
		"href": "/users/USR-0000-0001",
		"icon": null,
		"name": "Will Smith"
	}
}

buyer

seller

account

audit

object

Possible audit events: Created, Updated, Activated, Disabled, Deactivated, or Deleted.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "deleted": { "at": "...", "by": { } }
}

Example

{
	"id": "LCE-8893-6916-0000",
	"href": "/accounts/licensees/LCE-8893-6916-0000",
	"contact": null,
	"name": "Stark Industries",
	"externalId": null,
	"status": "Active",
	"address": null,
	"useBuyerAddress": false,
	"icon": null,
	"description": null
}

{
	"id": "LCE-8893-6916-0000",
	"href": "/accounts/licensees/LCE-8893-6916-0000",
	"contact": null,
	"name": "Stark Industries",
	"externalId": null,
	"status": "Active",
	"address": null,
	"useBuyerAddress": false,
	"icon": null,
	"description": null,
	"account": {
		"id": "ACC-5563-4382",
		"href": "/accounts/accounts/ACC-5563-4382",
		"type": "Client",
		"status": "Active",
		"icon": null,
		"name": "AdAstraflexx"
	},
	"buyer": {
		"id": "BUY-8928-0965",
		"href": "/accounts/buyers/BUY-8928-0965",
		"name": "Stark Industries"
	},
	"seller": {
		"id": "SEL-4717-3953",
		"href": "/accounts/sellers/SEL-4717-3953",
		"externalId": "SWO_CA",
		"name": "SoftwareOne Canada, Inc."
	}
}

List Licensees

List Licensee items in the Licensees collection.

Get Licensee

Get a single licensee object by ID.

Create Licensee

Create a new licensee object.

Update Licensee

Update the licensee object.

You can update the licensee Seller Object, except the status (which is managed through the disable, enable, deleteendpoints) buyers id and sellers id.

Delete Licensee

Delete the licensee object.

Enable Licensee

Enable the previously disabled licensee object.

Disable Licensee

Disable the licensee object.

Module

Module Object

The module object represents a module in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary module identifier.

Example: "MOD-1234"

name

string

Name of the module.

Example: "Invoices"

description

string

Description of the module.

Example: "Invoices module"

accountTypes

string

Defines presence of module for each account type.

Example: ["vendor", "client", "operations"]

isEnabledByDefault

boolean

Defines whether the module is enabled by default.

Example: "true"

isConfigurable

boolean

Defines whether module’s access can be changed.

Example: "true"

Example

{
  "id": "MOD-1234",
  "name": "Invoices",
  "description": "Invoices module",
  "accountTypes": ["vendor", "client", "operations"],
  "isEnabledByDefault": true,
  "isConfigurable": false
}

List Modules

Get a list of modules in the platform.

Users

User Object

The user object represents an individual user in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary user identifier.

Example: "USR-1671-0642"

href

string

Relative reference to object on API (always /v1/accounts/users/{id}).

Example: "/v1/accounts/users/USR-1671-0642"

email

string

Email address of the user.

Example: "will.smith@softwareone.com"

status

string

Status of the user.

enum values

New

Invited

Invitation

Expired

Active

Blocked

Disabled

Deleted

A user can have the Invited or InvitationExpired status only if they haven't joined the account.

name

string

User's name.

Example: "Will Smith"

firstName

string

First name of the user.

Example: "Will"

lastName

string

Last name of the user.

Example: "Smith"

phone

object

User's country code and phone number.

Example:

{ 
  "prefix": "+34",
  "number": "660707172"
}

SSO

bool

Flag if a user logs using SSO.

Example: "true"

acceptedTerms

bool

Flag if user has accepted terms and conditions.

Example: "true"

accounts

List of accounts that user is added to, not returned on users account sub-collection.

Example:

[
  {
    "id": "ACC-1671-0642",
    "name": "You Are a Test Account"
  }
]

groups

Groups that the user belongs to.

Example:

[
  {
    "id": "UGR-5116-6265",
    "name": "Administrators"
  },
  {
    "id": "UGR-5116-6565",
    "name": "Fulfillment Managers"
  }
]

settings

invitation

object

Added only in context of account (on account sub-collection), and only in case of user being invited.

Example:

{
  "code": "910B14E6CB2343A09CB32F24BBC4BEF1",
  "status": "Invited"
}

invitation.code

string

Invitation code sent to user to invite them to the platform.

Example: "910B14E6CB2343A09CB32F24BBC4BEF1"

invitation.status

string

Invitation status for the user in account.

Example: "Invited"

audit

object

Meaning of audit events: On GLobal User

created - when user was created (once in lifecycle).
updated - when user parameters changed last time.
login - when user last time logged in.
blocked - when user was blocked last time.

On account subcollection, in additional to above:

invited - when user was invited into account (dropped on join).
joined - when user was accepted invitation to account.
access - when user last time switched to the account context.

Example:

{
    "created": { ... },
    "updated": { ... },
    "joined": { ... },
    "login": { ... },
    "access": { ... }
}

Example

{
  "id": "USR-6375-2499",
  "href": "/v1/accounts/users/USR-6375-2499",
  "email": "test12.test@SWO1.com",
  "name": "John Smith",
  "firstName": "John",
  "lastName": "Smith",
  "status": "Invited",
  "phone": { 
      "prefix": "+34",
      "number": "660707172"
  },
  "accounts": [
		{
			"id": "ACC-1671-0642",
			"href": "/accounts/ACC-1671-0642",
			"icon": null,
			"name": "You Are a Test Account"
		}
  ],
  "group": [
      {
        "id": "UGR-5116-6265",
        "name": "Administrators"
      },
      {
        "id": "UGR-5116-6565",
        "name": "Fulfillment Managers"
      }
  ],
  "invitation": {
    "code": "910B14E6CB2343A09CB32F24BBC4BEF1",
    "status": "Invited"
  }
}

List Users

Get a list of all platform users.

Get User

Get a single user by ID.

Set User Password

Set passwords for non-SSO users during onboarding.

Update User

Update a user.

Unblock User

Unblock a previously blocked user.

Block User

Block a user.

User Groups

Group Object

The group object represents a user group in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary group identifier.

Example: "UGR-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/groups/UGR-1234-1234"

icon

string

Relative path to token’s logo.

Example: "/static/accounts/UGR-1234-1234/logo.png"

name

string

Group name.

Example: "Stark Industries"

description

string

Group description.

Example: "Stark's marketing group"

modules

List of modules available for the group.

Example: "Invoices"

default

bool

Indicated if the user group is set as default in the account. There is only one default user-group per account.

Example: "true"

stats

stats

Statistics of the group. A

group can be deleted only if the UsersCount is 0.

Example:

{
  "users": 123
}

Example

{
	"id": "UGR-5116-6265",
	"href": "/user-groups/UGR-5116-6265",
	"name": "Test-1",
	"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.",
	"modules": [
		{
			"id": "MOD-1756-1452",
			"name": "Access management"
		},
		{
			"id": "MOD-9042-8216",
			"name": "Account management"
		}
	],
	"icon": "https://picsum.photos/210/201",
	"default": true,
	"stats": {
		"users": 123
	}
}

List User Groups

Get the user groups collection.

Get User Group

Get a single user group by ID.

Create User Group

Create a user group for the client account.

Update User Group

Update a user group.

Delete User Group

Delete a user group.

Account User

Account User Object

The user object represents an individual user in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary account user identifier.

Example: "AUSR-5709-0422-8243"

href

string

Relative reference to object on API (always /v1/accounts/account-users/{id}).

Example: "/v1/accounts/account-users/AUSR-5709-0422-8243"

user

account

{
  "id": "ACC-1671-0642",
  "href": "/accounts/ACC-1671-0642",
  "icon": null,
  "name": "You Are a Test Account"
}

invitation

Invitation.Status

Invitation information: Invited, Active, InvitationExpired

Example:

{
  "url": "https://client.softwareone.com/accept-invite?code=invitationCode",
  "status": "Invited"
}

groups

List of user groups.

Example:

[
  {
    "id": "UGR-8447-7590",
    "href": "/user-groups/UGR-8447-7590",
    "name": "test2",
    "description": "test2",
    "logo": "",
    "isDefault": false
  }
]

Example

{
    "$meta": {
        "pagination": {
            "offset": 0,
            "limit": 10,
            "total": 1
        },
        "omitted": [
            "audit"
        ]
    },
    "data": [
        {
            "id": "AUSR-4134-7183-7330",
            "href": "/account-users/AUSR-4134-7183-7330",
            "user": {
                "id": "USR-6375-2499",
                "href": "/users/USR-6375-2499",
                "email": "test12.test@SWO1.com",
                "firstName": "test",
                "lastName": "test"
            },
            "groups": [
                {
                    "id": "UGR-8447-7590",
                    "href": "/user-groups/UGR-8447-7590",
                    "name": "test2",
                    "description": "test2",
                    "logo": "",
                    "isDefault": false
                }
            ],
            "account": {
                "id": "ACC-1671-0642",
                "href": "/accounts/ACC-1671-0642",
                "icon": null,
                "name": "You Are a Test Account"
            },
            "invitation": {
                "code": "TEST",
                "status": "Invited"
            }
        }
    ]
}

List Account Users

Get all users assigned to an account.

Get Account User

Get a single account user by ID.

Create Account User

Invite a user to the account.

Assign User to a Group

Assign an account user to a specific group.

Update User to Group Assignment

Remove User

Removes a user from a specific group.

Accept User Invitation

Accepts user invitation to the account.

Resend User Invitation

Resend an invitation to the user.

Send New Invitation

Send new invitation when invite expires.

Delete Account User

Deletes a user from the account. The user remains active in the other accounts.

API Tokens

Token Object

The token object represents an authentication token user in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary API token identifier.

Example: "TKN-1671-0642"

href

string

Relative reference to object on API.

Example: "/v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330"

name

string

Name of the token.

Example: "Robot"

description

string

Token description.

Example: "Test token"

status

string

Status of the token: Active, Disabled, Deleted

modules

At least one modules validation when creating API Token.

account

Account under which the token has been defined.

Example:

{
  "id": "ACC-123-123",
  "name": "Microsoft"
}

token

string

Authentication code.

Example

{
    "id": "TKN-4134-7330",
    "href": "/v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330",
    "name": "Name",
    "description": "Description",
    "icon": "",
    "status": "Active",
    "modules": [
        {
            "id": "MOD-1756-1452"
        },
        {
            "id": "MOD-9042-8216"
        }
    ],
    "token": "CODE"
}

Create Token

Create a new token object for the specific account.

List Tokens

Get the API tokens collection.

Get Token

Get a single API token by ID.

Update Token

Update the specified token object.

Delete Token

Delete an existing token object.

Enable Token

Enable the specified token object.

Disable Token

Disable the specified token object.