Get Tenant
API code: GET_TENANT
Pre-authorized role(s): PROVIDER_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS
Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/core/tenants/{tenantId}
COPY
Path Parameters
string
tenantId
Required
The full tenant ID or tenant name. It must be URL encoded.
Query Parameters
boolean
include-onboard-timeline
Optional
Indicating whether to include tenant onboard timeline
Responses
200
OK
Returns RegionTenant of type(s) application/json
{
"id": "string",
"name": "string",
"poseAsPermission": "string",
"solutionOrg": false,
"fullName": "string",
"source": "string",
"modifier": "string",
"inactiveRegions": [
{
"name": "string",
"endpoint": "string",
"platform": "string",
"version": "string",
"tenantName": "string",
"tenantId": "string",
"storageTenantId": "string",
"logoUri": "string",
"active": false,
"defaultMapping": false,
"siteId": "string",
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"storageClasses": [
"string"
],
"lastModifiedDate": "string",
"timeline": {
"id": 0,
"tenantId": "string",
"accountId": "string",
"accountFlow": "string",
"accountStatus": "string",
"accountEmail": "string",
"creationDate": "string",
"lastModifiedDate": "string",
"accountHistories": [
{
"status": "string",
"action": "string",
"date": "string"
}
],
"tenantEnabled": false,
"accountHealth": "string",
"healthMessage": "string",
"cleanBeforeReady": false
},
"poseAsPermission": "string",
"health": "string"
}
],
"activeRegions": [
{
"name": "string",
"endpoint": "string",
"platform": "string",
"version": "string",
"tenantName": "string",
"tenantId": "string",
"storageTenantId": "string",
"logoUri": "string",
"active": false,
"defaultMapping": false,
"siteId": "string",
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"storageClasses": [
"string"
],
"lastModifiedDate": "string",
"timeline": {
"id": 0,
"tenantId": "string",
"accountId": "string",
"accountFlow": "string",
"accountStatus": "string",
"accountEmail": "string",
"creationDate": "string",
"lastModifiedDate": "string",
"accountHistories": [
{
"status": "string",
"action": "string",
"date": "string"
}
],
"tenantEnabled": false,
"accountHealth": "string",
"healthMessage": "string",
"cleanBeforeReady": false
},
"poseAsPermission": "string",
"health": "string"
}
],
"regionsToActivate": [
{
"name": "string",
"endpoint": "string",
"platform": "string",
"version": "string",
"tenantName": "string",
"tenantId": "string",
"storageTenantId": "string",
"logoUri": "string",
"active": false,
"defaultMapping": false,
"siteId": "string",
"usedBytes": 0,
"objectCount": 0,
"bucketCount": 0,
"storageClasses": [
"string"
],
"lastModifiedDate": "string",
"timeline": {
"id": 0,
"tenantId": "string",
"accountId": "string",
"accountFlow": "string",
"accountStatus": "string",
"accountEmail": "string",
"creationDate": "string",
"lastModifiedDate": "string",
"accountHistories": [
{
"status": "string",
"action": "string",
"date": "string"
}
],
"tenantEnabled": false,
"accountHealth": "string",
"healthMessage": "string",
"cleanBeforeReady": false
},
"poseAsPermission": "string",
"health": "string"
}
]
}string
id
Optional
id
string
name
Optional
name
string
poseAsPermission
Optional
poseAsPermission
Possible values are : DISALLOW, FULL_PERMISSION,
boolean
solutionOrg
Optional
solutionOrg
string
fullName
Optional
fullName
string
source
Optional
source
string
modifier
Optional
modifier