DICloak API – Browser Profile Group Interfaces

1. Browser Profile Group Interfaces

GET to Obtain the List of Browser Profile Groups

GET /v1/env/group

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer(int32)	No	Page number, defaulting to 1.
page_size	query	integer(int32)	No	Page size for pagination, defaulting to 10.
all	query	boolean	No	Whether to obtain the full amount of data. When it is true, page_no and page_size will be ignored.
detail	query	boolean	No	Whether details are needed.
name	query	string	No	Name.
remark	query	string	No	Remarks.
env_id	query	string	No	Included browser profile.
member_id	query	string	No	Authorized member.
X-API-KEY	header	string	Yes	None.

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "org_id": "string",
        "name": "string",
        "remark": "string",
        "member_list": [
          {
            "group_id": null,
            "env_group_name": null,
            "member_id": null,
            "member_name": null
          }
        ],
        "env_list": [
          {
            "name": null,
            "serial_num": null
          }
        ],
        "is_default": true
      }
    ],
    "total": 0
  }
}

Name	Type	Description
id	string	ID
create_time	string	Creation time
update_time	string	Modification time
org_id	string	Organization ID
name	string	Name
remark	string	Remarks
member_list	EnvironmentGroupMemberVO	Authorized members
env_list	Env	List of included browser profiles
is_default	boolean	Default group

EnvironmentGroupMemberVO

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

Env

Name	Type	Required	Description
name	string	No	Name
serial_num	string	No	Serial number

GET to Obtain the Details of the Browser Profile Group

GET /v1/env/group/{id}

Request Parameters

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

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "org_id": "string",
    "name": "string",
    "remark": "string",
    "member_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "env_list": [
      {
        "name": "string",
        "serial_num": "string"
      }
    ],
    "is_default": true
  },
  "next": "string"
}

Name	Type	Description
code	integer
msg	string
data	OpenEnvironmentGroupVO	Refer to the fields of the list
next	string

POST to Save the Browser Profile Group

POST /v1/env/group

Request Parameters

Name	Location	Type	Required	Description
X-API-KEY	header	string	Yes
body	body	EnvironmentGroupEditReq	No

{
  "name": "string",
  "member_ids": [
    "string"
  ],
  "remark": "string"
}

Name	Type	Required	Description
name	string	No	Name.
member_ids	string	No	Authorized members.
remark	string	No	Remarks.

Return Results

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "org_id": "string",
    "name": "string",
    "remark": "string",
    "member_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "env_list": [
      {
        "name": "string",
        "serial_num": "string"
      }
    ],
    "is_default": true
  },
  "next": "string"
}

Name	Type	Description
code	integer
msg	string
data	OpenEnvironmentGroupVO	Refer to the fields of the list
next	string

PUT to Modify the Browser Profile Group

PUT /v1/env/group/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes
X-API-KEY	header	string	Yes
body	body	No	No

{
  "name": "string",
  "member_ids": [
    "string"
  ],
  "remark": "string"
}

Name	Type	Required	Description
name	string	No	Name.
member_ids [string]	array of string	No	Authorized members.
remark	string	No	Remarks.

Return Results

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

DELETE: Delete the Browser Profile Group

DELETE /v1/env/group/{id}

Request Parameters

Name	Location	Type	Required	Description
id	path	string	Yes
X-API-KEY	header	string	Yes
body	body	EnvGroupDelReq	No

{
  "del_env": true
}

Name	Type	Required	Description
del_env	boolean	No	Whether to delete the browser profile or not.

Return Results

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