Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ AppCube OU Isolation Interface/ Interface for Querying User Data Permissions
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for Querying User Data Permissions

Scenario Description

Querying user data permissions.

Interface Method

GET

Interface URL

https://domain name/apiaccess/CC-Management/openapi/queryDataAuthByUserId?userId=10gg000001LgVE0ufPUW&offset=0&limit=100. For example, service.besclouds.com

Request Description

Table 1 Query parameters

No.

Parameter

Parameter Type

Mandatory or Not

Description

1

userId

String

True

User ID.

For user ID on the AppCube or SUM user ID on the AICC, the user ID on the AppCube is preferred.

3

offset

Int

False

Offset query.

4

limit

Int

False

Number of accessible organizations that can be queried on each page of the user data permission.

The value is [0,1000]. If this parameter is not set, the value is 100.
Table 2 Request header parameters

No.

Parameter

Parameter Type

Mandatory or Not

Description

1

X-APP-Key

string

True

appKey field, which is the user ID

2

Authorization

string

True

Authentication field. The format is Bearer (space){Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Parameter Type

    Mandatory or Not

    Description

    1

    returnCode

    String

    True

    Response code.

    • 0: success
    • -1: failed.

    2

    description

    String

    True

    Response result description.

    3

    data

    Object

    True

    Query result list.

    3.1

    orgDataAuth

    Map<String, boolean>

    True

    Organization permission.

    For example, <queryWriteOwnerOrg, true>

    3.2

    accessOrgList

    List<Object>

    True

    List of accessible organizations.

    3.2.1

    orgId

    String

    True

    ID of the accessible organization.

    3.2.2

    accessType

    String

    True

    Access type.

    3.2.3

    funPermMap

    Map <String, String>

    True

    Organization menu permission.

    3.3

    tenantId

    String

    True

    Tenant space ID.

    3.4

    userOwnerOrgId

    String

    True

    ID of the organization to which the user belongs.

    3.5

    totalAccessOrgs

    Int

    True

    Total number of accessible organizations.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Message Example

Request header:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

Response parameters:

{
    "returnCode": "0",
    "description": "success",
    "data": {
        "orgDataAuth": {
            "queryOwnerOrg": true,
            "querySubOrg": true,
            "writeSubOrg": true,
            "queryAllOrg": true,
            "writeAllOrg": true
        },
        "accessOrgList": [
            {
                "orgId": "1743229000370058604",
                "accessType": "R;C",
                "funPermMap": {}
            },
            {
                "orgId": "1743411069067247710",
                "accessType": "R;W;C",
                "funPermMap": {}
            }
        ],
        "tenantId": "202503291154",
        "userOwnerOrgId": "1743229000370058604",
        "totalAccessOrgs": 4
    },
    "success": true,
    "failed": false
}