List User Groups¶
获取 OU 下的用户组列表。
操作权限¶
应用被授权 OU 的 administrator 策略。
请求格式¶
GET https://{apigw-address}/enos-iam-service/v2.3/usergroup/list
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 用户组所属的 OU ID。如何获取 orgId 信息>> |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | UserGroupResults 结构体 | 获取到的用户组信息总结,参见 UserGroupResults 结构体。 |
UserGroupResults 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
list | UserGroupInfo 结构体数组 | 用户组信息列表,参见 UserGroupInfo 结构体。 |
open | Integer | 一般为 0(不用的字段)。 |
total | Integer | 用户组总数。 |
offset | Integer | 一般为 -1(不用的字段)。 |
UserGroupInfo 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 用户组 ID。 |
name | String | 用户组名称。 |
users | User 结构体数组 | 一般为空(不用的字段)。 |
policys | Policy 结构体数组 | 策略信息列表,参见 Policy 结构体。 |
user_num | Integer | 用户组中包含的用户数量。 |
created_by | String | 用户组创建者用户名。 |
Policy 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 策略 ID。 |
code | String | 策略 code。 |
desc | String | 策略描述。 |
name | String | 策略名称。 |
type | Integer |
|
created_by | String | 策略创建者的用户名。 |
permissions | Map | 一般为空(不用的字段)。 |
updated_at | String | 一般为 null(不用的字段)。 |
示例¶
请求示例¶
url: https://{apigw-address}/enos-iam-service/v2.3/usergroup/list?orgId=yourOrgId
method: GET
返回示例¶
{
"fail": false,
"data": {
"list":[
{
"id": "userGroupId",
"name": "Admin group",
"users": [],
"policys": [],
"user_num": 2,
"created_by": "john.doe"
}
],
"open":0,
"total":1,
"offset":-1
},
"success": true,
"status": 0
}