Get Organization Roles¶
Get all roles under an organization structure.
Request Parameters (URI)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
orgId | Mandatory | String | The organization ID. |
locale | Optional | String | The language code. If unspecified, it is set to English by default.
|
Error Codes¶
Code | Message | Description |
---|---|---|
31400 | Lack of necessary parameters | Organization ID is required. |
31404 | Can not find this organization | The organization does not exist. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.2/organization/role/list?orgId={your_org_id}&locale={locale}
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":""
}