Get Organization Roles¶

获取 OU 内所有角色。

前提条件¶

应用需拥有“获取本 OU 内所有角色 ID，名称”的权限。如有需要，联系 OU 管理员获取权限。

请求格式¶

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

请求参数（URI）¶

名称

位置（Path/Query）

必需/可选

数据类型

描述

orgId

Query

必需

String

OU ID。如何获取 orgId 信息 >>

locale

Query

可选

String

指定以何种语言返回列表信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的列表信息。

响应参数¶

名称	数据类型	描述
roles	RoleDTO 结构体	角色结构列表。RoleDTO 结构体 >>

RoleDTO 结构体 ¶

名称	数据类型	描述
id	String	角色 ID。
name	String	角色名称。

错误码¶

代码	错误信息	描述
31400	Lack of necessary parameters	OU ID 不能为空。
31404	Can not find this organization	OU 不存在。

示例¶

请求示例¶

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

method: GET

返回示例¶

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