tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOrganization

Last updated: 2024-11-27 21:24:20

    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.
    Note: This field may return null, indicating that no valid values can be obtained.
    HostUin Integer Creator UIN.
    Note: This field may return null, indicating that no valid values can be obtained.
    NickName String Creator name.
    Note: This field may return null, indicating that no valid values can be obtained.
    OrgType Integer Organization type.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsManager Boolean Whether the member is the organization admin. Valid values: true (yes); false (no).
    Note: This field may return null, indicating that no valid values can be obtained.
    OrgPolicyType String Policy type. Valid values: Financial (finance management).
    Note: This field may return null, indicating that no valid values can be obtained.
    OrgPolicyName String Policy name.
    Note: This field may return null, indicating that no valid values can be obtained.
    OrgPermission Array of OrgPermission List of member financial permissions.
    Note: This field may return null, indicating that no valid values can be obtained.
    RootNodeId Integer Organization root node ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Organization creation time.
    Note: This field may return null, indicating that no valid values can be obtained.
    JoinTime String Member joining time.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsAllowQuit String Whether the member is allowed to leave. Valid values: Allow, Denied.
    Note: This field may return null, indicating that no valid values can be obtained.
    PayUin String Payer UIN.
    Note: This field may return null, indicating that no valid values can be obtained.
    PayName String Payer name.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsAssignManager Boolean Whether the member is the trusted service admin. Valid values: true (yes); false (no).
    Note: This field may return null, indicating that no valid values can be obtained.
    IsAuthManager Boolean Whether the member is the verified entity admin. Valid values: true (yes); false (no).
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Getting 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": 100000546922,
        "IsManager": true,
        "NickName": "",
        "OrgId": 13,
        "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": "Finance 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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy