Dealers

List dealers

get

List a collection of dealers.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/dealers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "level": "DISTRIBUTOR",
      "name": "text",
      "email": "[e-mail]",
      "display_name": "text",
      "website": "text",
      "phone": "text",
      "address": "text",
      "description": "text",
      "max_tenants": 1,
      "max_extensions": 1,
      "tenant_full_access": true
    }
  ]
}

OK

Create a dealer

post

Create a dealer.

Authorizations

Body

enabledboolean · default: trueoptional

Enable this dealer or not.

levelstring · enumrequired

Dealer level includes:

• DISTRIBUTOR: the first level of dealers.
• SUB_DISTRIBUTOR: the second level of dealers.
• RESELLER: the third level of dealers.

Options: DISTRIBUTOR, SUB_DISTRIBUTOR, RESELLER

namestring · min: 1 · max: 64required

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

passwordstringrequired

The password of dealer.

emailall ofoptional

The email address of user.

The email address.

display_namestring · max: 1024optional

The display name of user.

websitestringoptional

The website of user.

phonestring · max: 32optional

The mobile phone number of user.

addressstring · max: 128optional

The address.

descriptionstringoptional

The description of dealer.

max_tenantsinteger · int32 · default: 100required

The maximum number of tenants that the dealer is allowed to create.

max_extensionsinteger · int32 · default: 50000required

The maximum number of extensions that the dealer is allowed to create.

tenant_full_accessboolean · default: trueoptional

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/dealers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "level": "DISTRIBUTOR",
    "name": "text",
    "password": "text",
    "email": "[e-mail]",
    "display_name": "text",
    "website": "text",
    "phone": "text",
    "address": "text",
    "description": "text",
    "max_tenants": 1,
    "max_extensions": 1,
    "tenant_full_access": true
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Success

Retrieve a dealer

get

Get details of the dealer by it's unique ID.

Authorizations

Path parameters

idall ofrequired

The unique ID of dealer.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/dealers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": "[e-mail]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 1,
  "max_extensions": 1,
  "tenant_full_access": true
}

OK

Update a dealer

post

Modify the settings of the dealer.

Authorizations

Path parameters

idall ofrequired

The unique ID of dealer.

The unique ID of the resource.

Body

enabledboolean · default: trueoptional

Enable this dealer or not.

emailall ofoptional

The email address of user.

The email address.

display_namestring · max: 1024optional

The display name of user.

websitestringoptional

The website of user.

phonestring · max: 32optional

The mobile phone number of user.

addressstring · max: 128optional

The address.

descriptionstringoptional

The description of dealer.

max_tenantsinteger · int32 · default: 100optional

The maximum number of tenants that the dealer is allowed to create.

max_extensionsinteger · int32 · default: 50000optional

The maximum number of extensions that the dealer is allowed to create.

tenant_full_accessboolean · default: trueoptional

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/dealers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "email": "[e-mail]",
    "display_name": "text",
    "website": "text",
    "phone": "text",
    "address": "text",
    "description": "text",
    "max_tenants": 1,
    "max_extensions": 1,
    "tenant_full_access": true
  }'

200

4XX

200

No body

OK