Get User Structures


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

Operation Permissions


  • User login to Application Portal is required.

  • Selecting an OU is required.

Request Format


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

Request Parameters (Header)


Name

Mandatory/Optional

Data Type

Description

Authorization

Mandatory

String

The access token (or bearer token). The format of the parameter’s string is Bearer {your token}. Refer to Log In or Refresh Access Token to learn how to get the access token

Response Parameters


Name

Data Type

Description

data

Data Struct

The list of organization structure

Data Struct


Name

Data Type

Description

structures

StructureDTO Struct

The list of organization structures

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 APP_PORTAL_S_TDKKeqfYBK3m5z3LRgKVqThWDYnRBN44"}

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":""
}