User Tenant List
Returns the list of tenants for a particular user.
Resource Informations
Name | Value |
---|---|
Requires authentication? | Yes |
Rate limited? | No |
Request
Request headers
Key | Value |
---|---|
Authorization | Bearer token |
Content-Type | application/json |
HTTP request URL for SSMS
GET https://{tenantId}.{hostname}/digitanium/v4/tenantlist/{userName}
HTTP request URL for SHIFT
GET https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}/tenantlist
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameter fields are required.
Request body
No request body fields are required.
Response
Field Name | Type | Description |
---|---|---|
message | String | The message explains the result of the API call. Refer to Response status Information for details. |
status | String | The status of the API call. Refer Response status Information for details. |
Subsystem | String | Subsystem categorizes the type of API that has been called. Refer to Subsystem details for details. |
data | Object | User details |
Sample Response
{
"message": "Tenant list fetched successfully",
"status": "OK",
"subSystem": 5,
"data": [
"demo",
"demotest",
"test001",
"perf"
]
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | Tenant list fetched successfully |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | USER_NOT_FOUND | User does not exist |