REST Tenant Management
- Jason Andrew
Analytics
Resource URL Summary
Retrieve the details of an existing Tenant object
GET /up/v5/entity/${id}
Create a new Tenant object
POST /up/v5/entity
Update an existing Tenant object
PUT /up/v5/entity/${id}
Delete an existing Tenant object
DELETE /up/v5/entity/${id}
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specific Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
|
| Yes | The Tenant object's |
API Specifics
Retrieve the details of an existing Tenant object
This REST API will return the details of the specified Tenant object, based on the id value.
URL
GET /up/v5/entity/${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, and the response body will contain the details of the Tenant 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.
Create a new Tenant object
This REST API will create a new Tenant object, based on the supplied object details.
Only the ServiceBroker master Tenant can create Tenant objects.
URL
POST /up/v5/entity
HTTP Request Body
This request requires a Tenant object supplied in the HTTP request body.
Please note, when creating a new Tenant object, the EntityId field need not be supplied, unless ServiceBroker is intended to integrate with ServiceMobility. When this is the case, the EntityId field must be supplied, and match that of the ServiceMobility system.
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.
Update an existing Tenant object
This REST API will update a specified Tenant object, based on the id value and supplied object details.
URL
PUT /up/v5/entity/${id}
HTTP Request Body
This request requires a Tenant object supplied in the HTTP request body.
Please note, when updating an existing Tenant object, the AuthType field must not be supplied, as updating the authentication type of an existing Tenant is not supported.
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.
Delete an existing Tenant object
This REST API will delete the specified Tenant object, based on the id value.
URL
DELETE /up/v5/entity/${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.