Grant a host privilege

Request

Grant a new privilege on the host account which allows the targetted user to perform a subset of management operations based on their assigned role.

Security

SessionKey(Required scopes: customeradministrator)

Path

hostintegerrequired

Unique identifier of the requested host

Bodyapplication/json

userstring, (email)required

The email address of the user to whom the privilege is to be granted.

rolestringrequired

Role that the privilege should confer upon the user.

Enum:"Administrator""Editor""Viewer"

curl -i -X POST \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/privileges' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "user": "billy.butcher@fbsa.gov",
    "role": "Administrator"
  }'

Responses

The privilege was successfully granted to the user.

Bodyapplication/json

selfstringrequired

URI of the privilege resource.

userstring, (email)required

Email adddress of the user to which this privilege belongs.

roleobjectrequired

The role assigned to the specified user by this privilege.

typestringrequired

Resource type to which this privilege grants access.

Enum:"Host""Event"

resourcestring^[0-9]{14}$required

Unique identifier of the resource to which this privilege grants access.

pendingbooleanrequired

True if the privileged user needs to signup for a TickeTing account, false if not.

Response

{
  "self": "/hosts/16951985851389/privileges/18294757620193",
  "user": "billy.butcher@fbsa.gov",
  "role": {
    "name": "Administrator",
    "permissions": [ … ]
  },
  "type": "host",
  "resource": 16993717817996,
  "pending": false
}