Create a new API client.
POST
/apiclients
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ClientSecret | string | --- | --- | --- | ||
| AccessTokenDuration | Required | integer | int32 | --- | --- | |
| Active | boolean | --- | --- | --- | ||
| AppName | Required | string | --- | --- | --- | |
| RefreshTokenDuration | integer | int32 | --- | --- | ||
| DefaultContextUserName | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| AllowAnyBuyer | boolean | --- | --- | --- | ||
| AllowAnySupplier | boolean | --- | --- | --- | ||
| AllowSeller | boolean | --- | --- | --- | ||
| IsAnonBuyer | boolean | --- | --- | --- | ||
| OrderCheckoutIntegrationEventID | string | --- | --- | --- | ||
| OrderReturnIntegrationEventID | string | --- | --- | --- | ||
| AddToCartIntegrationEventID | string | --- | --- | --- | ||
| MinimumRequiredRoles | array | --- | --- | --- | ||
| MinimumRequiredCustomRoles | array | --- | --- | --- | ||
| MaximumGrantedRoles | array | --- | --- | --- | ||
| MaximumGrantedCustomRoles | array | --- | --- | --- | ||
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | Read Only | string | --- | --- | --- | |
| ClientSecret | string | --- | --- | --- | ||
| AccessTokenDuration | integer | int32 | --- | --- | ||
| Active | boolean | --- | --- | --- | ||
| AppName | string | --- | --- | --- | ||
| RefreshTokenDuration | integer | int32 | --- | --- | ||
| DefaultContextUserName | string | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
| AllowAnyBuyer | boolean | --- | --- | --- | ||
| AllowAnySupplier | boolean | --- | --- | --- | ||
| AllowSeller | boolean | --- | --- | --- | ||
| IsAnonBuyer | boolean | --- | --- | --- | ||
| AssignedBuyerCount | Read Only | integer | int32 | --- | --- | |
| AssignedSupplierCount | Read Only | integer | int32 | --- | --- | |
| OrderCheckoutIntegrationEventID | string | --- | --- | --- | ||
| OrderCheckoutIntegrationEventName | Read Only | string | --- | --- | --- | |
| OrderReturnIntegrationEventID | string | --- | --- | --- | ||
| OrderReturnIntegrationEventName | Read Only | string | --- | --- | --- | |
| AddToCartIntegrationEventID | string | --- | --- | --- | ||
| AddToCartIntegrationEventName | Read Only | string | --- | --- | --- | |
| MinimumRequiredRoles | array | --- | --- | --- | ||
| MinimumRequiredCustomRoles | array | --- | --- | --- | ||
| MaximumGrantedRoles | array | --- | --- | --- | ||
| MaximumGrantedCustomRoles | array | --- | --- | --- | ||