REST Tenant Token Management
- Mickey Bushman
- Jason Andrew
Resource URL Summary
Retrieve all System Access Tokens
GET /up/v5/entityToken
Create a new System Access Token
POST /up/v5/entityToken
Update an existing System Access Token
PUT /up/v5/entityToken/${id}
Delete an existing System Access Token
DELETE /up/v5/entityToken/${id}
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specific Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
|
| Yes | The System Access Token ID. |
API Specifics
Retrieve all System Access Tokens
This REST API will return the details of all System Access Tokens belonging to the authenticated Tenant.
URL
GET /up/v5/entityToken
HTTP Request Body
This request does not require a request body.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned, and the response body will contain an array of System Access Token objects.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.
Create a new System Access Token
This REST API will create a new System Access Token belonging to the authenticated Tenant.
URL
POST /up/v5/entityToken
HTTP Request Body
This request requires a System Access Token object supplied in the HTTP request body.
Please note, when creating a new System Access Token object, only the Name (and optionally the Active) field(s) may be supplied.
The EntityId field will be set to the value matching the authenticated Tenant making the API call, and the ID and JWT values will be automatically generated.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned, and the response body will contain the new System Access Token object.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.
Update an existing System Access Token
This REST API will update a System Access Token belonging to the authenticated Tenant.
URL
PUT /up/v5/entityToken/${id}
HTTP Request Body
This request requires a System Access Token object supplied in the HTTP request body.
Please note, when updating an existing System Access Token object, only the Name and/or Active fields can be supplied.
The other object fields may not be updated.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned, and the response body will contain the updated System Access Token object.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.
Delete an existing System Access Token
This REST API will delete a System Access Token belonging to the authenticated Tenant.
URL
DELETE /up/v5/entityToken/${id}
HTTP Request Body
This request does not require a request body.
HTTP Response
Success
On success, an HTTP response code of 200 will be returned.
Error
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.