Get User Group


获取用户组详细信息。

操作权限

应用被授权组织的 administrator 策略。

请求格式

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

请求参数（URI）

名称 位置（Path/Query） 必需/可选 数据类型 描述
orgId Query 必需 String 用户组所属的组织 ID。如何获取 orgId 信息>>
id Query 必需 String 用户组 ID。

响应参数

名称 数据类型 描述
data UserGroupInfo 结构体 用户组详细信息，参见 UserGroupInfo 结构体。

UserGroupInfo 结构体

名称 数据类型 描述
id String 用户组 ID。
name String 用户组名称。
users User 结构体数组 用户信息列表，参见 User 结构体。
policys Policy 结构体数组 策略信息列表，参见 Policy 结构体。
user_num Integer 用户组中包含的用户数量。
created_by String 用户组创建者用户名。

User 结构体

名称 数据类型 描述
id String 用户的用户 ID。
name String 用户的用户名。
org_id String 用户所属的组织 ID。
org_name String 用户所属的组织名称。
auth_type Integer

认证类型。

  • 0：EnOS
  • 1：LDAP
  • 2：SSO
email String 用户的邮箱。
mobile String 用户手机号码。
is_phone_verified Boolean
  • true：手机号码已验证。
  • false：手机号码没验证。
is_email_verified Boolean
  • true：邮箱已验证。
  • false：邮箱没验证。
link_name String 一般为 null（不用的字段）。
state Integer

账号状态。

  • 0：停用。
  • 1：启用。
multiple_factor Integer

多因子认证类型。

  • 0：无需验证。
  • 1：手机验证。
  • 2：邮箱验证。
  • 3：手机和邮箱验证。
organizations String Array 一般为空（不用的字段）。
user_groups String Array 一般为空（不用的字段）。

Policy 结构体

名称 数据类型 描述
id String 策略 ID。
code String 策略 code。
desc String 策略描述。
name String 策略名称。
type Integer
策略类型。

1：预置的管理员策略

2：自定义策略

8：预置策略
created_by String 策略创建者的用户名。
permissions Map 一般为空（不用的字段）。
updated_at String 一般为 null（不用的字段）。

示例

请求示例

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

返回示例

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