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)

Required/Optional

Data Type

Description

orgId

Query

Required

String

The ID of the OU 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.

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
}