- Service Overview
- Billing
- Getting Started
-
User Guide
- Before You Start
- Buying an Instance
- Instance Management
-
Enterprise Administrator Guide
- Logging In to the OneAccess Administrator Portal
- User Management
-
Resources
- Overview
-
Applications
- Adding an Application
- Enabling, Disabling, or Deleting an Application
- General Information
- Authentication Integration
- Synchronization Integration
- Login Configuration
- Access Control
- Object Models
- Authorization Management
- API Permission Management
- Application Permission Management
- Security Settings
- Audit Logs
- APIs
- Authentication
- Security
- Audit
- Settings
- Common User Guide
- Key Operations Recorded by CTS
-
Best Practices
- OneAccess Best Practices
- Identity Source Integration
-
Application Integration
-
Logging In to the Huawei Cloud Through User Portal
- Introduction
- Logging In to Single Huawei Cloud Account via OneAccess Without Password (SAML - Virtual User SSO)
- Logging In to Multiple Huawei Cloud Accounts via OneAccess Without Password (SAML - Virtual User SSO)
- Logging In to Single Huawei Cloud Account via OneAccess Without Password (SAML - IAM User SSO)
- Logging In to Multiple Huawei Cloud Accounts via OneAccess Without Password (SAML - IAM User SSO)
- Logging In to Huawei Cloud via OneAccess Without Password (OIDC)
- SSO Access to Applications Through SAML
- SSO Access to Applications Through OAuth 2.0
- SSO Access to Applications Through OIDC
- SSO Access to Applications Through CAS
- SSO Access to Applications Through Plug-in Autocompletion
-
Logging In to the Huawei Cloud Through User Portal
- Data Synchronization
- Authentication Provider Integration
- Authorizing IAM Users to Access a OneAccess Instance Administrator Portal
- API Usage
- Configuring MFA for User Login
- Developer Guide
-
API Reference
- Before You Start
- API Overview
-
OneAccess APIs
-
Management APIs
- Calling APIs
- Access Credentials
-
User Management
- Creating a User
- Modifying a User
- Deleting a User
- Enabling a User
- Disabling a User
- Changing a User Password
- Verifying and Modifying the Original User Password
- Querying User Details by User ID
- Querying User Details by Username
- Querying the User List
- Authorizing an Application Account
- Querying All Authorized Application Accounts of a User
- Organization Management
- Application Organization Management
- Application Account Management
- Application Role Management
- User APIs
- Application Integration APIs
-
Management APIs
- Appendix
- FAQs
- General Reference
Copied.
Querying the Organization List
Function
This API is used to query a specified organization and its sub-organizations.
Constraints
null
URI
GET /api/v2/tenant/organizations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
all_child |
No |
Boolean |
Whether to obtain sub-organizations of all levels. |
limit |
Yes |
Integer |
Number of data records on each page. |
offset |
Yes |
Integer |
Page number. |
org_id |
No |
String |
Organization ID. When the value of org_id is null and that of all_child is false, all root organizations (organizations of the highest level) are returned. When the value of org_id is null and that of all_child is true, in addition to the returned root organization, all sub-organizations are returned. When the value of org_id is orgId and that of all_child is true, this organization and its sub-organizations of all levels are returned. When the value of org_id is orgId and that of all_child is false, this organization and its lower-level organizations are returned. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Authorization |
Yes |
String |
Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Long |
Total number of organizations. |
organizations |
Array of ResponseOrgInfo objects |
Organization list. |
Parameter |
Type |
Description |
---|---|---|
org_id |
String |
Organization ID. |
org_code |
String |
Organization ID, which is globally unique. |
name |
String |
Organization name, which is unique at the corresponding level. |
parent_id |
String |
Parent organization ID. |
category |
String |
Organization type. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error details. |
Example Requests
Query an organization list in pagination mode. In addition to the returned root organization, the first 100 sub-organizations are returned. If the number of records is less than 100, all the records are returned.
GET https://{domain_name}/api/v2/tenant/organizations?org_id=&all_child=true&offset=0&limit=100 Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
Example Responses
Status code: 200
Request successful.
{ "total" : 2, "organizations" : [ { "org_code" : "1000000", "org_id" : "20210619175242949-6040-CA7ECF...", "name" : "Headquarter", "category" : "department", "parent_id" : null }, { "org_code" : "1000001", "org_id" : "20210623103509267-6ABA-201FFC...", "name" : "Subdepartments", "category" : "department", "parent_id" : "20210619175242949-6040-CA7ECF..." } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Invalid parameter. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot