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)	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>>
id	Query	Required	String	The user group ID.

Response Parameters¶

Name	Data Type	Description
data	UserGroupInfo Struct	The user group details. For more information, see UserGroupInfo Struct.

UserGroupInfo Struct ¶

Name	Data Type	Description
id	String	The user group ID.
name	String	The user group name.
users	Array of User Structs	The list of users. For more inforation, see User Struct.
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 name of the user who created the user group.

User Struct ¶

Name	Data Type	Description
id	String	The user ID.
name	String	The user name.
org_id	String	The OU ID which the user belongs to.
org_name	String	The name of the OU which the user belongs to.
auth_type	Integer	The authentication type. 0: EnOS 1: LDAP 2: SSO
email	String	The email of the user.
mobile	String	The mobile number of the user.
is_phone_verified	Boolean	`true`: The mobile number is verified. `false`: The mobile number is not verified.
is_email_verified	Boolean	`true`: The email is verified. `false`: The email is not verified.
link_name	String	An unused parameter, usually null.
state	Integer	The state of the account. `0`: Disabled. `1`: Enabled.
multiple_factor	Integer	The multi-factor authentication type. `0`: Disabled. `1`: By SMS. `2`: By email. `3`: By SMS and email.
organizations	String Array	An unused parameter, usually blank.
user_groups	String Array	An unused parameter, usually blank.

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