Generate a new API Token

POST 
/tokens

Generate an API Token for a project to be used to authenticate requests within the project.

Permissions

You must set the functions allowed by this API Token by selecting which types of requests this API Token is allowed to make. Valid options are: calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video

Request

application/json

Body

required

name stringrequired

The name representing the API token.

permissions arrayrequired

The permissions you would like to enable for this token. Valid permissions are calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video

subproject_id string

The unique identifier of the subproject you would like to create a token for. The subproject passed must be a child of the project used to authenticate the request.

Responses

200

OK

application/json

Schema

Schema

id string

The ID of the created API Token.

name string

The name of the created API Token.

permissions array

The permissions enabled for this token.

token string

The API token that can be used along with the project ID for basic authentication

Example (from schema)

{
  "id": "ea14556a-984f-11ee-b9d1-0242ac120002",
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ],
  "token": "PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191"
}

422

Unprocessable Entity. You may have specified invalid parameters.

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_auth_token_permissions",
  "message": "Permissions contains invalid selections (valid permissions are: calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video)",
  "attribute": "permissions",
  "url": "https://developer.signalwire.com/rest/overview/error-codes/#invalid_auth_token_permissions"
}

Loading...