Get
Get a single tenant
Request
URI
GET
https://{api_host}/tca/tenancy/api/v1/tenants/{tenantId}
COPY
Path Parameters
string
tenantId
Required
The identifier of the tenant
tenantId example
c11ade69-5f11-4bef-9cbe-d52fcecb5bea
Responses
200
Single tenant
Returns Tenant of type(s) application/json
This response body class contains all of the following: TenantBase , InlineTenant1
{
"name": "My tenant 1",
"description": "My tenant 1 for production",
"idpId": "03e25897-8de1-42bd-83f3-367b8018beb6",
"id": "ee0876dc-36ce-41e8-b334-f7cdfb94e8a4",
"createdAt": "2023-02-13T13:19:37.448Z",
"creationUser": "joe@vsphere.local",
"links": {
"self": {
"href": "/telco/admin/api/tenants/v1/tenant/ee0876dc-36ce-41e8-b334-f7cdfb94e8a4"
},
"update": {
"href": "/telco/admin/api/tenants/v1/tenant/ee0876dc-36ce-41e8-b334-f7cdfb94e8a4"
},
"delete": {
"href": "/telco/admin/api/tenants/v1/tenant/ee0876dc-36ce-41e8-b334-f7cdfb94e8a4"
},
"impersonate": {
"href": "/telco/admin/api/tenants/v1/tenant/ee0876dc-36ce-41e8-b334-f7cdfb94e8a4"
}
}
}
400
Returns BadRequest of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
Returns InternalServerError of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}