Get Organization List


List the organizations(OUs) which the user belongs to according to the access token.

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/organization/list

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

organizations

IdNamePair Struct

The details of the OUs. IdNamePair Struct >>

IdNamePair Struct


Name

Data Type

Description

id

String

The OU ID.

name

String

The OU name.

Error Code


Code

Description

31401

Access Token is invalid

Samples

Request Sample


url: https://{apigw-address}/app-portal-service/v2.2/user/organization/list

method: GET

headers: {"Authorization":"Bearer your_token"}

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": {
    "organizations": [
      {
        "id": "your_org_id_1",
        "name": "your_org_name_1"
      },
      {
        "id": "your_org_id_2",
        "name": "your_org_name_2"
      }
    ]
  }
}