Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Tenant Configurations/ Querying Tenant Information
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Tenant Information

Function

Queries tenant information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:tenants:listTenantProfile

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/tenant/profile

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

project_id

String

Tenant ID (tenant_id).

project_name

String

Tenant name.

tenant_domain_id

String

Domain ID of the tenant.

service_status

String

Service status.

  • active: activated

  • inactive: inactive

open_with_ad

Boolean

Whether to interconnect with the AD. If an AD is available, a message is displayed, indicating that both the single-session mode and multi-session mode are supported. If no AD is available, a message is displayed, indicating that only the VDI single-session mode is supported.

tenant_domain_name

String

Domain name of the tenant.

create_time

String

Time when the tenant information is created.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "project_id" : "165454xx5845",
  "project_name" : "165454xx5845",
  "tenant_domain_id" : "165454xx5845",
  "service_status" : "active",
  "open_with_ad" : true,
  "tenant_domain_name" : "165454xx5845",
  "create_time" : "2016-03-28T00:00:00Z"
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Tenant Configurations