Get User Structures¶

Get the information of the organization structure to which a user is assigned.

Prerequisites¶

The user has logged in to Application Portal and entered an OU. You can log in to Application Portal through the Log In API and select the OU through the Choose Organization API.

Request Format¶

GET https://{apigw-address}/app-portal-service/v2.2/user/structures

Request Parameters (Header)¶

Name	Required/Optional	Data Type	Description
Authorization	Required	String	The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of `Bearer {your token}`. You can call the Log In or Refresh Access Token API to obtain the access token.

Response Parameters¶

Name	Data Type	Description
structures	StructureDTO Struct	The list of organization structures. StructureDTO Struct >>

StructureDTO Struct¶

Name	Data Type	Description
id	String	The node ID in the organization structure.
name	String	The name of the organization structure.
parentId	String	The parent node ID.

Error Code¶

Code	Description
31401	The provided access token is not valid
31512	Organization unselected

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/user/structures
method: GET
header: {"Authorization":"Bearer your_token"}

Return Sample¶

{
    "code":0,
    "data":{
        "structures":[
          {
            "id":"your_node_id_1",
            "name":"your_node_name_1",
            "parentId":"your_parent_node_id_1"
          },
          {
            "id":"your_node_id_2",
            "name":"your_node_name_2",
            "parentId":"your_parent_node_id_2"
          },
        ]
    },
    "message":""
}