Get User Group


Get the user group information.

Operation Permissions

Applications assigned with the administrator policy in the OU.

Request Format

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

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>>

id

Query

Mandatory

String

The user group ID.

Response Parameters

Name

Data Type

Description

data

UserGroupInfo Struct

The user group details. For more information, see UserGroupInfo Struct.

Samples

Request Sample

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

Return Sample

{
  "status": 0,
  "message": null,
  "data": {
    "id": "yourRequestedUserGroupId",
    "name": "Admin Group",
    "created_by": "userID3",
    "user_num": 3,
    "users": [
      {
        "is_phone_verified": false,
        "is_email_verified": true,
        "id": "userID1",
        "auth_type": 0,
        "link_name": null,
        "name": "User 1",
        "mobile": "",
        "email": "user1@gmail.com",
        "org_id": "orgId",
        "org_name": "Demo",
        "state": 1,
        "multiple_factor": 0,
        "organizations": [],
        "user_groups": []
      },
      {
        "is_phone_verified": true,
        "is_email_verified": true,
        "id": "userID2",
        "auth_type": 0,
        "link_name": null,
        "name": "User 2",
        "mobile": "65-88888887",
        "email": "user2@gmail.com",
        "org_id": "orgId",
        "org_name": "Demo",
        "state": 1,
        "multiple_factor": 0,
        "organizations": [],
        "user_groups": []
      },
      {
        "is_phone_verified": false,
        "is_email_verified": true,
        "id": "userID3",
        "auth_type": 0,
        "link_name": null,
        "name": "User 3",
        "mobile": "65-88888888",
        "email": "user3@gmail.com",
        "org_id": "orgId",
        "org_name": "Demo",
        "state": 1,
        "multiple_factor": 0,
        "organizations": [],
        "user_groups": []
      }
    ],
    "policys": [
      {
        "id": "305",
        "name": "administrator",
        "desc": "administrator",
        "created_by": "",
        "type": 1,
        "code": "admin",
        "updated_at": null,
        "permissions": {}
      },
      {
        "id": "13318",
        "name": "Policy A",
        "desc": "",
        "created_by": "userID3",
        "type": 2,
        "code": "",
        "updated_at": null,
        "permissions": {}
      }
    ]
  },
  "fail": false,
  "success": true
}