Tencent Cloud Organization
- Operation Guide
- Organization Settings
- Department Management
- Member Account Management
- Member Finance Management
- Unified Organization Payment Mode (Pay-on-Behalf)
- Member Access Management
- Service Control Policy
- Resource Management
- Resource Sharing
- Management of Shared Resources by the Sharer
- Additional Operations
- Management of Shared Resources by the Shared User
- Organization Service Management
- Member Audit
- Identity Center Management
- Introduction to Identity Center
- Identity Center Use Cases
- Settings
- SCIM Synchronization
- Examples of SCIM Synchronization
- Examples of Synchronization from OneLogin via SCIM
- SSO Login
- Manage Permission Configuration
- Manage Multi-account Authorization
- Manage CAM User Synchronization
- API Documentation
- Making API Requests
- Organization Settings APIs
- Department and Member Management APIs
- ListOrganizationIdentity
- Unified Member Login APIs
- Organization Service Management APIs
- Resource Sharing APIs
- Identity Center Management APIs
- Identity Center User Management APIs
- Identity Center User Group Management APIs
- Identity Center Management SCIM Synchronization APIs
- Identity Center Single Sign-On Management APIs
- Identity Center Permission Configuration Management APIs
- Identity Center Multi-Account Authorization Management APIs
- Identity Center Sub-User Synchronization Management APIs
- TCO API 2018-12-25
- Making API Requests
- Read APIs
- Write APIs
- Related Agreement
DocumentationTencent Cloud OrganizationAPI DocumentationDepartment and Member Management APIsDescribeOrganizationMembers
DescribeOrganizationMembers
Last updated: 2025-02-26 11:51:49
1. API Description
Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to get the list of organization members.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeOrganizationMembers. |
| Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Offset | Yes | Integer | Offset, which is an integer multiple of the value of Limit. Default value: 0. |
| Limit | Yes | Integer | Limit, which defaults to 10. Value range: 1-50. |
| Lang | No | String | Valid values: en (Tencent Cloud International); zh (Tencent Cloud). |
| SearchKey | No | String | Search by member name or ID. |
| AuthName | No | String | Entity name. |
| Product | No | String | Abbreviation of the trusted service, which is required during querying the trusted service admin. |
| Tags.N | No | Array of Tag | Member tag search list, with a maximum of 10. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Items | Array of OrgMember | Member list. |
| Total | Integer | Total number. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Obtaining the Member List
This example shows you how to obtain the member list.
Input Example
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationMembers
<Common request parameters>
{
"Lang": "zh",
"Limit": 10,
"Offset": 0
}
Output Example
{
"Response": {
"Items": [
{
"CreateTime": "2021-04-17 12:19:07",
"MemberType": "Invite",
"MemberUin": 111111111111,
"Name": "test2",
"NodeId": 27,
"NodeName": "node1",
"IsAllowQuit": "Denied",
"OrgPermission": [
{
"Id": 1,
"Name": "Allow the root account to view the consumption information of sub-accounts"
},
{
"Id": 2,
"Name": "Allow the root account to view the financial information of sub-accounts"
}
],
"OrgPolicyName": "Financial management",
"OrgPolicyType": "Financial",
"Remark": "123",
"PayUin": "",
"PayName": "",
"OrgIdentity": [],
"BindStatus": "Unbound",
"PermissionStatus": "Confirmed",
"UpdateTime": "2021-04-17 12:19:07"
},
{
"CreateTime": "2021-04-16 11:49:39",
"MemberType": "Create",
"MemberUin": 222222222222,
"Name": "name2",
"NodeId": 26,
"NodeName": "node2",
"IsAllowQuit": "Denied",
"OrgPermission": [
{
"Id": 1,
"Name": "Allow the root account to view the consumption information of sub-accounts"
},
{
"Id": 2,
"Name": "Allow the root account to view the financial information of sub-accounts"
},
{
"Id": 3,
"Name": "Allow the root account to allocate funds to sub-accounts"
},
{
"Id": 4,
"Name": "Allow the root account to consolidate the bills of sub-accounts"
},
{
"Id": 5,
"Name": "Allow the root account to issue invoices on behalf of sub-accounts"
}
],
"OrgPolicyName": "Financial management",
"OrgPolicyType": "Financial",
"Remark": "",
"PayUin": "",
"PayName": "",
"OrgIdentity": [],
"BindStatus": "Unbound",
"PermissionStatus": "Confirmed",
"UpdateTime": "2021-04-16 11:49:39"
}
],
"RequestId": "a0fe0702-5757-4aa4-8872-74b70a4c1b7a",
"Total": 2
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.OperateBillingPermissionErr | An error occurred while manipulating the billing member permission. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| ResourceNotFound.OrganizationNodeNotExist | The organization node does not exist. |
| ResourceNotFound.OrganizationNotExist | The organization does not exist. |
| ResourceNotFound.OrganizationServiceNotExist | The organization service does not exist. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No