List
List all tenants
Request
URI
GET
https://{api_host}/tca/tenancy/api/v1/tenants
COPY
Query Parameters
string
nextpage_opaque_marker
Optional
May contain page_no=
nextpage_opaque_marker example
nextpage_opaque_marker=page_no=1,page_size=20,sort=createdAt:descstring
filter
Optional
The filter for listing
filter example
filter=(eq,name,myIdp)
Header Parameters
boolean
x-tca-anymatch
Optional
If false, then the filter expressions are taken in logical AND relation, otherwise OR
x-tca-anymatch example
true
Responses
200
List of tenants
Returns Array of Tenant of type(s) application/json
[
{
"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"
}
}
}
]Response Headers
string
Link
undefined
integer
TotalRowCount
The total number of matching tenants
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"
}
]
}