Get Organization User Group List¶
获取组织内所有用户组。
请求格式¶
GET https://{apigw-address}/app-portal-service/v2.3/organization/userGroup/list
请求参数(URI)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
orgId |
必需 |
String |
组织 ID。 |
locale |
可选 |
String |
语言代码。不填默认为英语。
|
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
userGroups |
userGroups 结构体 |
用户组列表。 |
userGroup 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
用户组 ID。 |
name |
String |
用户组名称。 |
错误码¶
代码 |
描述 |
---|---|
31400 |
组织 ID 为空或应用无效。 |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.3/organization/userGroup/list?orgId=your_org_id&locale=en_US
method: GET
返回示例¶
{
"code": 0,
"message": "OK",
"data": {
"userGroups": [
{
"name": "your_user_group_name",
"id": "your_user_group_id"
}
]
}
}