Versions Compared

Version Old Version 16 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.0.0

The Tenant Token Management REST APIs provides the capability to create, update and delete ServiceBroker Tenant System Access Tokens.

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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}

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specific Parameters

ParameterTypeRequired?Description

${id}

string

Yes

The System Access Token ID.

API Specifics

Panel
borderColor#D3D3D3

Retrieve all System Access Tokens

This REST API will return the details of all System Access Tokens belonging to the authenticated Tenant.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.

Code Block
languagejs
firstline1
titleJSON Format
linenumberstrue
collapsetrue
[
	{
		// System Access Token Object
	},
	{
		// System Access Token Object 
	},
	...	
]

Error

Include Page
_Default Response
_Default Response

Panel
borderColor#D3D3D3

Create a new System Access Token

This REST API will create a new System Access Token belonging to the authenticated Tenant.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/entityToken

HTTP Request Body

This request requires a System Access Token object supplied in the HTTP request body.

Note

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.

Include Page
_System Access Token Object Format
_System Access Token Object Format

Error

Include Page
_Default Response
_Default Response

Panel
borderColor#D3D3D3

Update an existing System Access Token

This REST API will update a System Access Token belonging to the authenticated Tenant.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/entityToken/${id}

HTTP Request Body

This request requires a System Access Token object supplied in the HTTP request body.

Note

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.

Include Page
_System Access Token Object Format
_System Access Token Object Format

Error

Include Page
_Default Response
_Default Response

Panel
borderColor#D3D3D3

Delete an existing System Access Token

This REST API will delete a System Access Token belonging to the authenticated Tenant.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default Response
_Default Response