Update Tenant

Update Tenant

API code: UPDATE_TENANT
Pre-authorized role(s): PROVIDER_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS

Request
URI
PATCH
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.

Request Body
Tenant of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "solutionOrg": false,
    "tenantSetting": {
        "poseAsPermission": "string"
    },
    "siteId": "string",
    "regionSiteId": "string",
    "source": "string",
    "fullName": "string",
    "platforms": {
        "platforms": {
            "name": "string",
            "version": "string",
            "regions": [
                "string"
            ],
            "storageClasses": [
                "string"
            ],
            "active": false,
            "storageTenantId": "string",
            "logoUri": "string",
            "defaultMapping": false,
            "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
            }
        }
    },
    "platform": {
        "name": "string",
        "logUri": "string"
    },
    "usedBytes": 0,
    "objectCount": 0,
    "bucketCount": 0,
    "lastModifiedDate": "string",
    "modifier": "string",
    "purgeState": "string",
    "deleteRequest": "string",
    "errorMessage": "string",
    "region": "string",
    "storagePolicyLocked": false,
    "storagePolicy": "string",
    "associatedOrgId": "string",
    "autoOnboardForbidden": false,
    "autoOnboardConfig": {
        "region": "string",
        "autoOnboard": false,
        "storagePolicyId": "string",
        "storagePolicyName": "string",
        "storagePolicyLocked": false
    },
    "active": false
}
string
id
Optional

id

string
name
Optional

name

boolean
solutionOrg
Optional

solutionOrg

TenantSetting
tenantSetting
Optional

tenantSetting

string
siteId
Optional

siteId

string
regionSiteId
Optional

regionSiteId

string
source
Optional

source

Possible values are : VCD, VCENTER, UNKNOWN,
string
fullName
Optional

fullName

object
platforms
Optional

platforms

Platform
platform
Optional

platform

integer As int64 As int64
usedBytes
Optional

usedBytes

integer As int64 As int64
objectCount
Optional

objectCount

integer As int64 As int64
bucketCount
Optional

bucketCount

string As date-time As date-time
lastModifiedDate
Optional

lastModifiedDate

string
modifier
Optional

modifier

string
purgeState
Optional

purgeState

Possible values are : NONE, REQUESTED, ONGOING, FINISHED,
string
deleteRequest
Optional

deleteRequest

Possible values are : NONE, SOFT, HARD,
string
errorMessage
Optional

errorMessage

string
region
Optional

region

boolean
storagePolicyLocked
Optional

storagePolicyLocked

string
storagePolicy
Optional

storagePolicy

string
associatedOrgId
Optional

associatedOrgId

boolean
autoOnboardForbidden
Optional

autoOnboardForbidden

AutoOnboardConfig
autoOnboardConfig
Optional

${api_param.autoOnboardConfig}

boolean
active
Optional

active

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Tenant of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "solutionOrg": false,
    "tenantSetting": {
        "poseAsPermission": "string"
    },
    "siteId": "string",
    "regionSiteId": "string",
    "source": "string",
    "fullName": "string",
    "platforms": {
        "platforms": {
            "name": "string",
            "version": "string",
            "regions": [
                "string"
            ],
            "storageClasses": [
                "string"
            ],
            "active": false,
            "storageTenantId": "string",
            "logoUri": "string",
            "defaultMapping": false,
            "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
            }
        }
    },
    "platform": {
        "name": "string",
        "logUri": "string"
    },
    "usedBytes": 0,
    "objectCount": 0,
    "bucketCount": 0,
    "lastModifiedDate": "string",
    "modifier": "string",
    "purgeState": "string",
    "deleteRequest": "string",
    "errorMessage": "string",
    "region": "string",
    "storagePolicyLocked": false,
    "storagePolicy": "string",
    "associatedOrgId": "string",
    "autoOnboardForbidden": false,
    "autoOnboardConfig": {
        "region": "string",
        "autoOnboard": false,
        "storagePolicyId": "string",
        "storagePolicyName": "string",
        "storagePolicyLocked": false
    },
    "active": false
}
string
id
Optional

id

string
name
Optional

name

boolean
solutionOrg
Optional

solutionOrg

TenantSetting
tenantSetting
Optional

tenantSetting

string
siteId
Optional

siteId

string
regionSiteId
Optional

regionSiteId

string
source
Optional

source

Possible values are : VCD, VCENTER, UNKNOWN,
string
fullName
Optional

fullName

object
platforms
Optional

platforms

Platform
platform
Optional

platform

integer As int64 As int64
usedBytes
Optional

usedBytes

integer As int64 As int64
objectCount
Optional

objectCount

integer As int64 As int64
bucketCount
Optional

bucketCount

string As date-time As date-time
lastModifiedDate
Optional

lastModifiedDate

string
modifier
Optional

modifier

string
purgeState
Optional

purgeState

Possible values are : NONE, REQUESTED, ONGOING, FINISHED,
string
deleteRequest
Optional

deleteRequest

Possible values are : NONE, SOFT, HARD,
string
errorMessage
Optional

errorMessage

string
region
Optional

region

boolean
storagePolicyLocked
Optional

storagePolicyLocked

string
storagePolicy
Optional

storagePolicy

string
associatedOrgId
Optional

associatedOrgId

boolean
autoOnboardForbidden
Optional

autoOnboardForbidden

AutoOnboardConfig
autoOnboardConfig
Optional

${api_param.autoOnboardConfig}

boolean
active
Optional

active


On This Page
Tenant Management Operations
GET
Get Auto Onboard Config
GET
Get Current Tenant
GET
Get Tenant
GET
List Associated Tenants
GET
List Shared Tenants
GET
List Storage Classes
GET
List Tenants
PATCH
Update Auto Onboard Config
PATCH
Update Tenant