- Development Integration
- /
- SDK
- /
- Python
- /
Authentication Module
- /
User Related Resources
- /
- Get Tenant List
¶ Get tenant list
Update time: 2025-07-23 07:34:21
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.
Get tenant list
¶ Method name
AuthenticationClient.get_tenant_list
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|
¶ Request response
Type: GetTenantListRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful, 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | array | response data |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"tenantId": "xxxx",
"tenantName": "xxxx",
"joinAt": "xxxx"
}
}
¶ Data structure
¶ UserTenantListDto
| Name | Type | Is it required | Description | Sample value |
|---|---|---|---|---|
| tenantId | string | yes | tenant ID | xxxx |
| tenantName | string | yes | tenant name | xxxx |
| joinAt | string | yes | time to join the tenant | xxxx |