Start Tenant Onboard Flow

Start Tenant Onboard Flow

API code: START_TENANT_ONBOARD_FLOW
Pre-authorized role(s): PROVIDER_ADMIN
Platform(s): AMAZON

Request
URI
POST
https://apaas-29.eng.vmware.com//api/v1/core/tenants/{tenantId}/onboard
COPY
Path Parameters
string
tenantId
Required

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

Request Body
TenantOnboard of type(s) application/json
Required 
{
    "startFlow": "string",
    "tenantId": "string",
    "accountId": "string",
    "email": "string",
    "action": "string",
    "notes": "string",
    "cleanBeforeReady": false,
    "siteId": "string"
}
string
startFlow
Optional

startFlow

Possible values are : INVITE, CREATE, REUSE, SHARE,
string
tenantId
Optional

tenantId

string
accountId
Optional

accountId

string
email
Optional

email

string
action
Optional

action

Possible values are : INVITE_ACCOUNT, CANCEL_INVITE, SYNC_STATE, ASSUME_ROLE, ENABLE_TENANT, DISABLE_TENANT, CREATE_ACCOUNT, RESET_ACCOUNT, REUSE_ACCOUNT, SHARE_ACCOUNT, REVOKE_ACCOUNT,
string
notes
Optional

notes

boolean
cleanBeforeReady
Optional

cleanBeforeReady

string
siteId
Optional

siteId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TenantOnboardTimeline of type(s) application/json 
{
    "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
}
integer As int64 As int64
id
Optional

id

string
tenantId
Optional

tenantId

string
accountId
Optional

accountId

string
accountFlow
Optional

accountFlow

Possible values are : INVITE, CREATE, REUSE, SHARE,
string
accountStatus
Optional

accountStatus

Possible values are : DISABLED, PENDING_ACCEPT, PENDING_AUTHORIZE, PENDING_CREATE, PENDING_REUSE, PENDING_SHARE, READY, ENABLED,
string
accountEmail
Optional

accountEmail

string As date-time As date-time
creationDate
Optional

creationDate

string As date-time As date-time
lastModifiedDate
Optional

lastModifiedDate

array of AccountHistory
accountHistories
Optional

accountHistories

boolean
tenantEnabled
Optional

tenantEnabled

string
accountHealth
Optional

accountHealth

Possible values are : NORMAL, ABNORMAL, PURGING,
string
healthMessage
Optional

healthMessage

boolean
cleanBeforeReady
Optional

cleanBeforeReady


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