Create a new API client

POST
/apiclients

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ApiClientAdmin

Request Body

PropertyTypeFormatMax LengthPossible Values
ClientSecretstring---------

AccessTokenDuration
Required
integerint32------
Activeboolean---------

AppName
Required
string---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

OrderCheckoutIntegrationEventIDstring---------

MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------

Response Body

PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---------

ClientSecretstring---------

AccessTokenDurationintegerint32------
Activeboolean---------

AppNamestring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

AssignedBuyerCount
Read Only
integerint32------
AssignedSupplierCount
Read Only
integerint32------
OrderCheckoutIntegrationEventIDstring---------

OrderCheckoutIntegrationEventName
Read Only
string---------
MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------