Get Organization Roles


获取组织内所有角色。

请求格式


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

请求参数(URI)


名称 必需/可选 数据类型 描述
orgId 必需 String 组织 ID。
locale 可选 String

语言代码。默认为英语。

  • 英语为 en_US
  • 中文为 zh_CN
  • 西班牙语为 es_ES
  • 日语为 ja_JP
  • 德语为 de_DE
  • 波兰语为 pl_PL

响应参数


名称 数据类型 描述
data Data 结构体 角色列表。

Data 结构体


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

RoleDTO 结构体


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

错误码


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

示例

请求示例


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