Schemas
- 01 Aug 2023
- 1 Minute to read
- Contributors
Schemas
- Updated on 01 Aug 2023
- 1 Minute to read
- Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Request Headers
Each request must include the following request headers:
| Property | Data Type | Description |
|---|---|---|
| Authorization* | String | Your temporary Access Token obtained using the /authorize method |
| Content-Type* | String | application/json |
Request Body Schemas
Groups
Groups contain applications, networks, locations, and members (users) that have access to resources.
CreateGroupDto
DTO for creating a group. Request body in POST /v1/groups.
Property | Data Type | Description |
|---|---|---|
name | String | Name of the group. |
description | String | Description of group. |
Group
Data for a single group. Response to POST /v1/groups, DELETE /v1/groups/{id}, POST /v1/groups/{groupId}/member/{userId}, and DELETE /v1/groups/{groupId}/member/{userId}. Found in GroupList.
| Property | Data Type | Description |
|---|---|---|
| name* | String | Name of the group. |
| isDefault* | Boolean | Whether the group is a default group (true). |
| applications* | Array of String | List of group applications. |
| networks* | Array of String | List of group networks. |
| vpnLocations* | Array of String | List of group locations. |
| users* | Array of String | List of group members. |
| id* | String | Group ID. |
GroupList
List of Group. Response to GET /v1/groups.
| Property | Data Type | Description |
|---|---|---|
| data* | Array of Group | List of groups. |
| page* | Number | Page number. |
| totalPage* | Number | Number of pages in list. |
| itemsTotal* | Number | Number of items in list. |
Was this article helpful?