Get Tenant

Get Tenant

Operation ID: getTenant
Get the storage tenant by ID. The cd_tenant_id in the response indicates the mapping between Cloud Director tenant and the storage tenant. "

Request
URI
GET
https://{api_host}/api/v1/tenants/{tenantId}
COPY
Path Parameters
string
tenantId
Required

Storage tenant ID


Authentication
This operation uses the following authentication methods.
Responses
200

The storage tenant is returned

Returns OsisTenant of type(s) application/json
{
    "name": "ACME",
    "active": true,
    "tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "cd_tenant_ids": [
        "8daca9a9-5b11-4f63-9c52-953a2ef77739"
    ]
}
string
name
Required

tenant name

boolean
active
Required

tenant status

string
tenant_id
Required

tenant id

array of string
cd_tenant_ids
Optional

Cloud Director tenant ids


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

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/tenants/{tenantId}