Get Users Structure List¶

Get the organization structures assigned to the users. You can request up to 1000 users at one time.

Prerequisites¶

The application has been granted the permission “Obtain all user permissions in the OU”. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/userStructures/structureList

Request Parameters (Body)¶

Name

Required/Optional

Data Type

Description

organizationId

Required

String

The OU ID. How to get organizationId >>

userIds

Required

List

The list of user IDs, supports up to 1000 IDs. How to get userId >>

locale

Optional

String

Specifies the language in which to return the list information. The following values are supported:

en_US: English

zh_CN: Chinese

es_ES: Spanish

ja_JP: Japanese

de_DE: German

pl_PL: Polish

By default, the list information in English en_US is returned.

Response Parameters¶

Name	Data Type	Description
usersUserStructures	UsersUserStructureDTO Struct	The information about users and their corresponding organization structures. UsersUserStructureDTO Struct >>
userStructures	UserStructureInfoDTO Struct	The organization structure information. UserStructureInfoDTO Struct >>

UsersUserStructureDTO Struct¶

Name	Data Type	Description
userId	String	The user ID.
structureIds	List	The list of organization structure IDs.

UserStructureInfoDTO Struct¶

Name	Data Type	Description
id	String	The organization structure ID.
name	String	The organization structure name.

Error Codes¶

Code	Description
31400	Errors such as incorrect parameters, empty parameters, character limits exceeded, and so on.
31403	The application has not been granted the “Obtain all user permissions in the OU” permission.
31404	OU not found.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/userStructures/structureList

method: POST

requestBody:
{"organizationId":"yourOrgId","userIds": ["user1","user2","user3"]}

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "usersUserStructures": [
            {
                "userId": "your_user_id",
                "structureIds": [
                    "your_node_id_1",
                    "your_node_id_2",
                    "your_node_id_3",
                    "your_node_id_4"
                ]
            }
        ],
        "userStructures": [
            {
                "name": "your_node_name_1",
                "id": "your_node_id_1"
            },
            {
                "name": "your_node_name_2",
                "id": "your_node_id_2"
            },
            {
                "name": "your_node_name_3",
                "id": "your_node_id_3"
            },
            {
                "name": "your_node_name_4",
                "id": "your_node_id_4"
            }
        ]
    }
}