Get Organization Roles¶

获取组织内所有角色。

操作权限¶

用户无需登录 Application Portal。

请求格式¶

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

请求参数（Header）¶

名称

必需/可选

数据类型

描述

orgId

必需

String

组织ID。

locale

可选

String

语言代码。不填默认为英语。

英语为 en_US

中文为 zh_CN

西班牙语为 es_ES

日语为 ja_JP

响应参数¶

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

data结构体¶

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

RoleDTO结构体¶

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

错误码¶

代码	描述
31404	组织不存在。

示例¶

请求示例¶

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

method: GET

返回示例¶

{
    "code":0,
    "data":{
        "roles":[
          {
            "id":"r133",
            "name":"name133"
          },
          {
            "id":"r134",
            "name":"name134"
          }
        ]
    },
    "message":""
}

Java SDK 调用示例¶

public class AppPortalSdkTest{
    @Test
    public void getOrganizationRolesTest() {
        OrganizationRoleListRequest request=new OrganizationRoleListRequest("your_org_id","your_locale");
        RoleListResponse response=Poseidon.config(PConfig.init().appKey("your_access_key").appSecret("your_secret_key").debug())
                .url("https://{apigw-address}").getResponse(request,RoleListResponse.class);
        assertNotNull("response data should not be null", response.data);
    }
}