Update Tenant Alias

Update Tenant Alias

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

Request
URI
PATCH
https://apaas-29.eng.vmware.com//api/v1/core/tenant-aliases/{tenantId}
COPY
Path Parameters
string
tenantId
Required

The full tenant ID or tenant name. It must be URL encoded.

Request Body
TenantAlias of type(s) application/json
Required 
{
    "orgId": "string",
    "storageTenantId": "string",
    "platforms": {
        "platforms": {
            "storageTenantId": "string",
            "users": [
                {
                    "username": "string",
                    "storageUserId": "string"
                }
            ],
            "tags": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    },
    "siteId": "string",
    "associated": false
}
string
orgId
Optional

orgId

string
storageTenantId
Optional

storageTenantId

object
platforms
Optional

platforms

string
siteId
Optional

siteId

boolean
associated
Optional

associated

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Task of type(s) application/json 
{
    "id": "string",
    "vcdId": "string",
    "vcdAssociationId": "string",
    "description": "string",
    "status": "string",
    "resourceType": "string",
    "resourceKey": "string",
    "progress": 0,
    "tenant": "string",
    "owner": "string",
    "startDate": "string",
    "endDate": "string",
    "reason": "string",
    "metadata": {
        "metadata": "string"
    }
}
string
id
Optional

id

string
vcdId
Optional

vcdId

string
vcdAssociationId
Optional

vcdAssociationId

string
description
Optional

description

string
status
Optional

status

Possible values are : NOT_STARTED, RUNNING, COMPLETED, FAILED, CANCELLED, HANGING, UNKNOWN,
string
resourceType
Optional

resourceType

string
resourceKey
Optional

resourceKey

integer As int32 As int32
progress
Optional

progress

string
tenant
Optional

tenant

string
owner
Optional

owner

string As date-time As date-time
startDate
Optional

startDate

string As date-time As date-time
endDate
Optional

endDate

string
reason
Optional

reason

object
metadata
Optional

metadata


On This Page
System Configuration Operations
POST
Add Tenant Aliases
DELETE
Cancel Tenant Onboard Flow
PATCH
Execute Global Bucket Sync Now
POST
Get Admin Console
GET
Get Global Bucket Sync Config
GET
Get Global Bucket Sync Result
GET
Get Global Cors
POST
Get Group Console
GET
Get Platform Preference
GET
Get Product Info
GET
Get Tenant Alias
GET
Get Tenant Onboard Flow
GET
List Aws Reusable Accounts
GET
List Aws Sharable Accounts
GET
List Platform Capabilities
GET
List Platforms
GET
List Storage Tenants
GET
List Tenant Aliases
DELETE
Revert Tenant Alias
POST
Start Tenant Onboard Flow
PATCH
Update Global Bucket Sync Config
PUT
Update Global Cors
PUT
Update Platform Preference
PATCH
Update Tenant Alias
PUT
Update Tenant Aliases