Get Tenant

Operation ID: getTenant
Get the tenant with tenant ID. The cd_tenant_id in the response indicates the mapping between Cloud Direct tenant and platform tenant. "

Request

URI

GET

https://{api_host}/api/v1/tenants/{tenantId}

COPY

Path Parameters

string

tenantId

Required

Tenant ID to get the tenant from the platform

Authentication

This operation uses the following authentication methods.

basicAuth

bearerAuth

Responses

200

The tenant is returned

Returns OsisTenant of type(s) application/json

{
    "tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "extensions": {
        "key": ""
    },
    "cd_tenant_ids": [
        "8daca9a9-5b11-4f63-9c52-953a2ef77739"
    ],
    "name": "ACME",
    "active": true,
    "health": "NOT_APPLICABLE"
}

string

name

Required

The suggested name of platform tenant; typically it is the VCD tenant name. If platform cannot adopt the this name, it is okay to use any string as platform tenant name. The identity of VCD and platform tenant are cd_tenant_id and tenant_id. Maintaining a record of tenant_id, cd_tenant_id and name in OSIS adaptor will make all work.

boolean

active

Optional

The active status of platform tenant. For the platforms not supporting activate/deactivate tenant, either returning active=true or not returning active indicates the platform tenant is in active status.

string

health

Optional

The health status of platform tenant. It should be null for the platforms not supporting tenant health status.

Possible values are : NOT_APPLICABLE, AVAILABLE, UNAVAILABLE,

string

tenant_id

Optional

The ID of platform tenant. The property is absent in tenant creation request, and is mandatory in the tenant creation response.

array of string

cd_tenant_ids

Optional

The ID of VCD tenants.

object

extensions

Optional

The extension properties to fulfill requirements of specific platform. Storage vendor should contact Object Storage Extension team before adding new extension properties. Currently only one property is supported - MinIO and HCP return tenant S3 endpoint via property key s3_endpoint.

404

The tenant doesn't exist

Operation doesn't return any data structure

501

The optional API is not implemented

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Authentication

Response