v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Authentication/API Key (Machine 2 Machine)

Create API Key

This is a limited action and will require special access to create API keys.

post/apikeys

Request body

descriptionstring required

This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use.

resellerstring required

This is the reseller that will limit the API key to access the resellers data set.

userstring

This is the main user extension for the user account.

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

user-scope'Basic User' | 'Simple User' | 'Advanced User' | 'Call Center Agent' | 'Call Center Supervisor' | 'Office Manager' | 'Reseller' | 'Super User' | 'NDP'

This is the scope that will be be used to enforce permissions for this API key and access.

ip-addressstring

Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated

readonly'yes' | 'no'

If enabled it will limit any get Scope to a read only verion providing only GET acces to the read actions. POST, PUT and DELETE will be rejected.

can-create-keys'yes' | 'no'

If enabled it will allow this key to make keys for lesser scopes then itself. It will not allow creations of scopes same or higher access level.

created-datetimestring date-time

The datetime that the key was created.

lastused-datetimestring date-time nullable

The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests

Example request

{
  "description": "Used by Vendor Xyz for Billing Automation",
  "user": "1000",
  "domain": "example.com",
  "ip-address": "1.2.3.4,5.6.7.0/24"
}

Response

descriptionstring required

This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use.

key-idstring required

This is the Key ID that will identify the key and allow for managment, audit tracking and monitoring.

keystring

This is the key that will need to be saved securly for use in accessing the API. It will only be shown once.

resellerstring required

This is the reseller that will limit the API key to access the resellers data set.

userstring

This is the main user extension for the user account.

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

user-scope'Basic User' | 'Simple User' | 'Advanced User' | 'Call Center Agent' | 'Call Center Supervisor' | 'Office Manager' | 'Reseller' | 'Super User' | 'NDP'

This is the scope that will be be used to enforce permissions for this API key and access.

ip-addressstring

Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated

readonly'yes' | 'no'

If enabled it will limit any get Scope to a read only verion providing only GET acces to the read actions. POST, PUT and DELETE will be rejected.

can-create-keys'yes' | 'no'

If enabled it will allow this key to make keys for lesser scopes then itself. It will not allow creations of scopes same or higher access level.

created-datetimestring date-time

The datetime that the key was created.

lastused-datetimestring date-time nullable

The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests

Example response

{
  "description": "Used by Vendor Xyz for Billing Automation",
  "key-id": "nsd-123dsa23",
  "user": "1000",
  "domain": "example.com",
  "ip-address": "1.2.3.4,5.6.7.0/24"
}