Get Organization Roles¶

Get all roles under an organization structure.

Prerequisites¶

The application has been granted the “Obtain the ID and name of all roles in the OU” permission. Contact the OU administrator to get the permission if necessary.

Request Format¶

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

Request Parameters (URI)¶

Name

Location (Path/Query)

Required/Optional

Data Type

Description

orgId

Query

Required

String

The OU ID. How to get orgId >>

locale

Query

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
roles	RoleDTO Struct	The list of role structs. RoleDTO Struct >>

RoleDTO Struct¶

Name	Data Type	Description
id	String	The role ID.
name	String	The role name.

Error Codes¶

Code	Message	Description
31400	Lack of necessary parameters	OU ID is required.
31404	Can not find this organization	The OU does not exist.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/organization/role/list?orgId=your_org_id&locale=en_US

method: GET

Return Sample¶

{
    "code":0,
    "data":{
        "roles":[
          {
            "id":"your_role_id_1",
            "name":"your_role_name_1"
          },
          {
            "id":"your_role_id_2",
            "name":"your_role_name_2"
          }
        ]
    },
    "message":""
}