tencent cloud

Tencent Cloud Organization

  • Product Introduction
  • Purchase Guide
  • Operation Guide
    • Console Overview
    • Organization Settings
    • Department Management
    • Member Account Management
    • Member Finance Management
    • Member Access Management
    • Resource Management
    • Member Audit
    • Identity Center Management
  • API Documentation
    • History
    • Introduction
    • API Category
    • Making API Requests
    • Organization Settings APIs
    • Department and Member Management APIs
    • ListOrganizationIdentity
    • Unified Member Login APIs
    • Organization Service Management APIs
    • Organization Management Policy 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
    • Data Types
    • Error Codes
    • TCO API 2018-12-25
  • Related Agreement
  • FAQs
  • Glossary
DocumentaçãoTencent Cloud OrganizationAPI DocumentationListOrganizationIdentityListOrganizationIdentity

ListOrganizationIdentity

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-20 00:28:13

1. API Description

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

This API is used to get the list of access identities of an organization member.

A maximum of 20 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: ListOrganizationIdentity.
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. It must be an integer multiple of the value of Limit. Default value: 0.
Limit Yes Integer The limit for the number of query results. Value range: 1-50. Default value: 10.
SearchKey No String Search by name.
IdentityId No Integer Identity ID, which can be searched by identity ID.
IdentityType No Integer Identity type. Valid values: 1 (Preset), 2 (Custom).

3. Output Parameters

Parameter Name Type Description
Total Integer Total quantity.
Items Array of OrgIdentity Item details.
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 List of Organization Member Access Identities

This example shows you how to obtain the list of organization member access identities.

Input Example

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

{
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "Response": {
        "Items": [
            {
                "IdentityId": 1,
                "IdentityAliasName": "identity_name",
                "Description": "admin identity",
                "IdentityPolicy": [
                    {
                        "PolicyId": 1,
                        "PolicyName": "AdministratorAccess"
                    }
                ],
                "IdentityType": 1,
                "UpdateTime": "2021-07-15 21:08:38"
            }
        ],
        "RequestId": "1d744bef-fa56-40e9-8e3b-5a88b122ad5e",
        "Total": 1
    }
}

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
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
ResourceNotFound.OrganizationNotExist The organization does not exist.
Anterior: SendOrgMemberAccountBindEmailPróximo: DescribeOrganizationMemberAuthIdentities

Ajuda e Suporte

Esta página foi útil?

comentários