Update Tenant
This request edits tenant’s attributes: the subdatabase name, the common name and the tenant’s licenses.
The tenant must be stopped before the subdatabase name is changed.
Resource
PATCH /tenants/<OID>
Where OID is the database ID of the tenant (the databaseId field).
Parameters
None
Payload
Fields
| Name | Patch Operations |
|---|---|
commonName |
|
subDatabaseName |
|
licenseCounts |
|
resellerName |
|
isTemplate |
|
Response
None
Context
| Authorization |
Master |
| Configuration |
Multi-tenant |
Errors
| HTTP code | Xelion code | Description |
|---|---|---|
400 |
10063 |
Not the master tenant. |
10165 |
Tenant is selected as a template for preloading tenants |
|
403 |
10101 |
Resource not accessable. User is not a master tenant administrator |
404 |
10060 |
No multi-tenant configuration. |
10100 |
No tenant with the specified ID exists. |
Example
Request
PATCH https://xelion.nl/api/v1/master/tenants/11
Payload
Add 10 user licenses of OID '1585938' to the tenant.
{
"operations": [
{
"op": "add",
"path": "/licenseCounts/1"
},
{
"op": "replace",
"path": "/licenseCounts/1/maxLicenses",
"value": 10
},
{
"op": "replace",
"path": "/licenseCounts/1/license",
"value": "1585938"
}
]
}