List User Groups¶

List the user groups under an OU.

Operation Permissions¶

Applications assigned with the administrator policy in the OU.

Request Format¶

GET https://{apigw-address}/enos-iam-service/v2.3/usergroup/list

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The ID of the organization to which the user group belongs to. How to get orgId>>

Response Parameters¶

Name	Data Type	Description
data	UserGroupResults Struct	Summary of the obtained results. For more information, see UserGroupResults Struct.

UserGroupResults Struct ¶

Name	Data Type	Description
list	Array of UserGroupInfo Structs	The list of user groups. For more infromation, see UserGroupInfo Struct.
open	Integer	An unused parameter, usually 0.
total	Integer	The total number of users.
offset	Integer	An unused parameter, usually -1.

UserGroupInfo Struct ¶

Name	Data Type	Description
id	String	The user group ID.
name	String	The user group name.
users	Array of User Structs	An unused parameter, usually blank.
policys	Array of Policy Structs	The list of policies. For more information, see Policy Struct.
user_num	Integer	The number of users in the user group.
created_by	String	The username of the user who created the user group.

Policy Struct ¶

Name	Data Type	Description
id	String	The policy ID.
code	String	The policy code.
desc	String	The policy description.
name	String	The policy name.
type	Integer	The policy type. 1: Preset admin policy 2: Custom policy created by users. 8: Preset policy
created_by	String	The username of the user who created the policy.
permissions	Map	An unused parameter, usually blank.
updated_at	String	An unused parameter, usually null.

Samples¶

Request Sample¶

url: https://{apigw-address}/enos-iam-service/v2.3/usergroup/list?orgId=yourOrgId
method: GET

Return Sample¶

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