# Cloud Tenant

A `Cloud Tenant` represents a cloud tenant object in the Marketplace Platform.

This object contains the following attributes:

<table data-full-width="false"><thead><tr><th width="186">Field Name</th><th width="149">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The primary identifier for the cloud tenant.</p><p>Example: CLT-1234-9876</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The name of the cloud tenant. </p><p>Example: AdAstraflex</p></td></tr><tr><td><code>status</code></td><td>string</td><td>The status of the cloud tenant. Allowed values: <code>active</code>, <code>disabled</code>, or <code>deleted</code>.</td></tr><tr><td><code>account</code></td><td>object</td><td>The <a href="/pages/tq2fdEq8olL6Ahrf4HVR"><code>account</code></a> to which the cloud tenant is assigned.</td></tr><tr><td><code>type</code></td><td>string</td><td><p>The type of cloud tenant. </p><p>Example: CSP365</p></td></tr><tr><td><code>externalId</code></td><td>object</td><td>A reference to <a href="#cloud-tenant-external-ids">Cloud Tenant External IDs</a>.</td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="/pages/RnSJqP4ZqAW7vD2MWeVM"><code>audit</code></a> object. </td></tr></tbody></table>

## Cloud Tenant External IDs object <a href="#cloud-tenant-external-ids" id="cloud-tenant-external-ids"></a>

<table data-full-width="false"><thead><tr><th width="191">Field Name</th><th width="142">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>pyraTenantId</code></td><td>string</td><td><p>Indicates the PYC tenant ID. </p><p>Example: ce4b61dd-9426-4b4a-855f-6162f790a457</p></td></tr><tr><td><code>cloudConsumptionId</code></td><td>string</td><td><p>Indicates the unique identifier of this cloud tenant in PYC.</p><p>Example: f94c03b5-c2ee-478a-964c-bfb591a7a205</p></td></tr><tr><td><code>providerId</code></td><td>string</td><td><p>Indicates the object identifier within the cloud provider, like AWS, Azure, and more. </p><p>Example: de14dafc-9323-40ed-bdbd-cbf32311d59e</p></td></tr></tbody></table>

## Example response

{% code lineNumbers="true" %}

```json
{
    "id": "CLT-3206-7146",   
    "account": {
        "id": "ACC-2253-2884",      
        "type": "Client",
        "status": "Active",
        "name": "AdAstrafleX"
    },
    "externalIds": {
        "cloudConsumptionId": "012b2a18-1df0-473f-8759-c3c019b54486",
        "providerId": "7270638c-ca21-4500-ac82-25dca634566a",
        "pyraTenantId": "c6469e97-302a-408a-8589-2122a0bb725d"
    },
    "name": "AdAstraflex Germany",
    "status": "Active",
    "type": "CspAzure",
    "audit": {
        "created": {
            "at": "2024-12-12T11:17:44.042Z",
            "by": {
                "id": "TKN-9299-7556",              
                "name": "Migration token"
            }
        }
    }
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/accounts-api/cloud-tenants.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.