DescribeOrganization

Download PDF

Last updated:2026-03-20 00:28:34

DescribeOrganization

Last updated: 2026-03-20 00:28:34

Download PDF

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to get the organization information.

A maximum of 40 requests can be initiated per second for this API.

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: DescribeOrganization.
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.
Lang	No	String	Valid values: `en` (Tencent Cloud International); `zh` (Tencent Cloud).
Product	No	String	Abbreviation of the trusted service, which is required during querying the trusted service admin.

3. Output Parameters

Parameter Name	Type	Description
OrgId	Integer	Organization ID.
HostUin	Integer	Creator UIN.
NickName	String	Creator'S nickname.
OrgType	Integer	Enterprise organization type.
IsManager	Boolean	Whether the organization admin. valid values: true, false.
OrgPolicyType	String	Policy type. Financial: financial management.
OrgPolicyName	String	Policy name.
OrgPermission	Array of OrgPermission	Member financial permission list.
RootNodeId	Integer	Root node ID of the organization.
CreateTime	String	Organization creation time.
JoinTime	String	Member join time.
IsAllowQuit	String	Whether to allow a member to exit. Valid values: Allow, Denied.
PayUin	String	Proxy payer UIN.
PayName	String	Payer name.
IsAssignManager	Boolean	Specifies whether an account belongs to a trusted service administrator. true: yes; false: no.
IsAuthManager	Boolean	Specifies whether an account belongs to a real-name entity administrator. true: yes; false: no.
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 Organization Details

Input Example

POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganization
<Common request parameters>

{}

Output Example

{
    "Response": {
        "CreateTime": "2021-04-15 21:07:54",
        "JoinTime": "2021-04-15 21:07:54",
        "HostUin": 1001,
        "IsManager": true,
        "NickName": "host_name",
        "OrgId": 101,
        "OrgPermission": [
            {
                "Id": 1,
                "Name": "viewBill"
            },
            {
                "Id": 2,
                "Name": "viewBalance"
            }
        ],
        "OrgPolicyName": "Financial management",
        "OrgPolicyType": "Financial",
        "OrgType": 1,
        "RootNodeId": 1001,
        "IsAllowQuit": "Allow",
        "PayUin": "",
        "PayName": "",
        "IsAssignManager": false,
        "IsAuthManager": false,
        "RequestId": "e5c09721-236b-4a55-a5d1-0513ac506245"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.OrganizationNotExist	The organization does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud