Create a new access token

Create an access token for the customer portal

Headers

Parameters

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/access_tokens/create

Must be authenticated as a reseller. If not authorised, a MustBeAReseller error will be returned.

Parameter	Type	Default
entity Required The record_id of the entity to provide access to	String	null
role Required The record_id or name of the role	String	null
options Any additional options, see expansion for valid values	Hash	{}

Parameter

Type

Default

entity Required

The record_id of the entity to provide access to

String

null

role Required

The record_id or name of the role

String

null

options

Any additional options, see expansion for valid values

Hash

{}

Error	Attributes
InvalidEntity The entity provided is invalid	entity The entity provided
EntityNotFound No entity was found given the ID provided	entity The entity provided
NoAccessToEntity Your authenticated identity is not permitted to access this entity	entity The entity provided
RoleNotFound No role was found given the ID provided	role The parent provided
ValidationError A validation error occurred	errors An array of errors

This action will return a access token structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.