DICloak API – Team Member Interface

1. Team Member Interface

GET to Obtain the Member List

GET /v1/members

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer	No	Page number. The default value is 1.
page_size	query	integer	No	Pagination size. The default value is 10.
all	query	boolean	No	Whether to obtain the full amount of data. When it is set to true, page_no and page_size will be ignored.
detail	query	boolean	No	Whether details are required.
user	query	string	No	User name/ID.
role_id	query	string	No	Member group (role).
env_group_id	query	string	No	Browser profile group ID.
status	query	string	No	Status (DISABLED for disabled, ENABLED for normal).
remark	query	string	No	Remarks.
authority	query	string	No	Qualification (SUPER_ADMIN for super administrator, ADMIN for administrator, MANAGER for manager, MEMBER for employee).
start_create_time	query	string	No	Start time.
end_create_time	query	string	No	End time.
X-API-KEY	header	string	Yes

Return Results

Name	Type	Required	Description
id	string	No	ID.
create_time	string	No	Creation time.
update_time	string	No	Update time.
user_id	string	No	User ID.
name	string	No	Name.
email	string	No	Email.
all_env_group	boolean	No	Whether it belongs to all groups.
env_group_list	EnvironmentGroupMemberVO	No	List of browser profile groups.
role_id	string	No	ID of the member group.
role_name	string	No	Name of the member group.
authority	string	No	Qualification (SUPER_ADMIN for super administrator, ADMIN for administrator, MANAGER for manager, MEMBER for employee).
status	string	No	Status (DISABLED for disabled, ENABLED for enabled).
remark	string	No	Remarks.
manager_id	string	No	ID of the superior manager.
current_user	boolean	No	Whether the logged-in account is the current member.
type	string	No	Member type (EXTERNAL, INTERNAL).
login_validate	boolean	No	Whether to enable login verification.
passwd	string	No	Password of the member (for internal members).

EnvironmentGroupMemberVO

Name	Type	Required	Description
group_id	string	No	ID of the browser profile group.
env_group_name	string	No	Name of the browser profile group.
member_id	string	No	ID of the member.
member_name	string	No	Name of the member.

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "user_id": "string",
        "name": "string",
        "email": "string",
        "all_env_group": true,
        "env_group_list": [
          {
            "group_id": null,
            "env_group_name": null,
            "member_id": null,
            "member_name": null
          }
        ],
        "role_id": "string",
        "role_name": "string",
        "authority": "SUPER_ADMIN",
        "status": "DISABLED",
        "remark": "string",
        "manager_id": "string",
        "current_user": true,
        "type": "EXTERNAL",
        "login_validate": true,
        "passwd": "string"
      }
    ],
    "total": 0
  }
}

GET to Obtain Member Details

GET /v1/member/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	None.
X-API-KEY	header	string	Yes	None.

Return Results

Name	Type	Required	Description
code	integer	No
msg	string	No
data	OpenMemberVO	No	Refer to the list.

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "user_id": "string",
    "name": "string",
    "email": "string",
    "all_env_group": true,
    "env_group_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "role_id": "string",
    "role_name": "string",
    "authority": "SUPER_ADMIN",
    "status": "DISABLED",
    "remark": "string",
    "manager_id": "string",
    "current_user": true,
    "type": "EXTERNAL",
    "login_validate": true,
    "passwd": "string"
  }
}

PUT to Modify a Member

PUT /v1/member/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes
X-API-KEY	header	string	Yes
body	body	object	No
name	body	string	Yes	Name.
email	body	string	Yes	Email.
phone	body	string	No	Mobile phone number.
authority	body	string	Yes	Qualification (SUPER_ADMIN for super administrator, ADMIN for administrator, MANAGER for manager, MEMBER for employee).
status	body	string	No	Status (DISABLED for disabled, ENABLED for normal).
remark	body	string	No	Remarks.
role_id	body	string	Yes	Member group.
all_env_group	body	boolean	No	Whether it belongs to all groups.
env_group_ids	body	string	No	IDs of browser profiles.
manager_id	body	string	No	ID of the manager.
agent_id	body	string	No	ID of the agent.
type	body	string	No	Member type.
passwd	body	string	No	Password of the member (for internal members).

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "authority": "SUPER_ADMIN",
  "status": "DISABLED",
  "remark": "string",
  "role_id": "string",
  "all_env_group": true,
  "env_group_ids": [
    "string"
  ],
  "manager_id": "string",
  "agent_id": "string",
  "type": "EXTERNAL",
  "passwd": "string"
}

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {}
}

DELETE: Delete a Member

DELETE /v1/member/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	None.
X-API-KEY	header	string	Yes	None.

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {},
  "next": "string"
}

POST to Create a Member

POST /v1/member

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "authority": "SUPER_ADMIN",
  "status": "DISABLED",
  "remark": "string",
  "role_id": "string",
  "all_env_group": true,
  "env_group_ids": [
    "string"
  ],
  "manager_id": "string",
  "agent_id": "string",
  "type": "EXTERNAL",
  "passwd": "string"
}

Request Parameters

Name	Location	Type	Required	Description
X-API-KEY	header	string	Yes	None.
body	body	object	No	None.
name	body	string	Yes	Name.
email	body	string	Yes	Email.
phone	body	string	No	Mobile phone number.
authority	body	string	Yes	Qualification (SUPER_ADMIN for super administrator, ADMIN for administrator, MANAGER for manager, MEMBER for employee).
status	body	string	No	Status (DISABLED for disabled, ENABLED for normal).
remark	body	string	No	Remarks.
role_id	body	string	Yes	Member group.
all_env_group	body	boolean	No	Whether it belongs to all groups.
env_group_ids	body	string	No	IDs of browser profiles.
manager_id	body	string	No	ID of the manager.
agent_id	body	string	No	ID of the agent.
type	body	string	No	Member type.
passwd	body	string	No	Password of the member (for internal members).

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "user_id": "string",
    "name": "string",
    "email": "string",
    "all_env_group": true,
    "env_group_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "role_id": "string",
    "role_name": "string",
    "authority": "SUPER_ADMIN",
    "status": "DISABLED",
    "remark": "string",
    "manager_id": "string",
    "current_user": true,
    "type": "EXTERNAL",
    "login_validate": true,
    "passwd": "string"
  },
  "next": "string"
}

Name	Type	Required	Description
code	integer	No
msg	string	No
data	OpenMemberVO	No	Refer to the list.
next	string	No

GET to Obtain the List of Role Tables

GET /v1/member/roles

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer	No	Page number, with the default value being 1.
page_size	query	integer	No	Page size, with the default value being 10.
all	query	boolean	No	Whether to obtain the full amount of data. When it is set to true, the values of pageNo and pageSize will be ignored.
detail	query	boolean	No	Whether details are needed.
name	query	string	No	Name of the member group.
member_id	query	string	No	ID of the member.
remark	query	string	No	Remarks.
X-API-KEY	header	string	Yes

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "code": "string",
        "name": "string",
        "status": "DISABLED",
        "remark": "string",
        "module_ids": [
          "string"
        ],
        "member_role_list": [
          {
            "org_id": null,
            "member_id": null,
            "member_name": null,
            "role_id": null,
            "role_name": null,
            "code": null
          }
        ],
        "current": true
      }
    ],
    "total": 0
  }
}

Name	Type	Description
id	string	ID.
create_time	string	Creation time.
update_time	string	Modification time.
code	string	Role code.
name	string	Role name.
status	string	Status (DISABLED for disabled, ENABLED for normal).
remark	string	Remarks.
module_ids	string	Module list.
member_role_list	MemberRoleVO	Members included in the role.
current	boolean	Whether it is in the current group.

MemberRoleVO

Name	Type	Required	Description
org_id	string	No	Organization ID.
member_id	string	No	Member ID.
member_name	string	No	Member name.
role_id	string	No	Role ID.
role_name	string	No	Role name.
code	string	No	Role code.

PATCH to Modify members

PATCH /v1/member/{id}

Request parameters

{
  "name": "string",
  "email": "string",//Required. If other parameters don't need to be modified, they'll stay the same if not provided.
  "phone": "string",
  "authority": "SUPER_ADMIN",
  "status": "DISABLED",
  "remark": "string",
  "role_id": "string",
  "all_env_group": true,
  "env_group_ids": [
    "string"
  ],
  "manager_id": "string",
  "agent_id": "string",
  "type": "EXTERNAL"
}

Return results

{
  "code": 0,
  "msg": "string",
  "data": {}
}