| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Workspace) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| id required | string |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| bulk required | Array of objects (Workspace) |
{- "bulk": [
- { }
]
}[- { }
]| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| id required | number |
{ }{ }| id required | number |
{ }{ }| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (WorkspaceEnrolment) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| bulk required | Array of objects (WorkspaceEnrolment) |
{- "bulk": [
- { }
]
}[- { }
]| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Roles) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Permissions) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| bulk required | Array of objects (Permissions) |
{- "bulk": [
- { }
]
}[- { }
]| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Profile) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| profileId required | number |
| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
]
}| profileId required | number |
| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
]
}| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| workspace required | string |
| group required | number |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| workspace required | string |
| group required | number |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| password required | string |
| name required | string |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
], - "password": "Str0ngP@S$w0rd!",
- "name": "account name"
}{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| password required | string |
| name required | string |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
], - "password": "Str0ngP@S$w0rd!",
- "name": "account name"
}{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| password required | string |
| name required | string |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
], - "password": "Str0ngP@S$w0rd!",
- "name": "account name"
}{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| password required | string |
| name required | string |
| groups | Array of strings |
| workspace | string |
| roles | Array of strings |
Array of objects (GroupsPermissionDto) |
| id required | number |
| name required | string |
| email required | string |
| createdAt required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "groups": [
- 1,
- 2,
- 3
], - "workspace": "2a441200-eece-11ed-a05b-0242ac120003",
- "roles": [
- 1,
- 2,
- 3
], - "permission": 2,
- "groupsPermission": [
- {
- "groupId": 1,
- "permission": 2
}, - {
- "groupId": 2
}
], - "password": "Str0ngP@S$w0rd!",
- "name": "account name"
}{- "id": 90,
- "name": "username",
- "email": "username@example.com",
- "createdAt": "2023-05-10T03:07:20.393Z",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| password required | string |
| newPassword required | string |
| email required | string |
| updatedAt required | string |
| enable required | boolean |
{- "password": "Str0ngP@S$w0rd!",
- "newPassword": "New$tr0ngP@sSw0rd!"
}{- "email": "username@example.com",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| password required | string |
| newPassword required | string |
| email required | string |
| updatedAt required | string |
| enable required | boolean |
{- "password": "Str0ngP@S$w0rd!",
- "newPassword": "New$tr0ngP@sSw0rd!"
}{- "email": "username@example.com",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| newPassword required | string |
| email required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "newPassword": "New$tr0ngP@sSw0rd!"
}{- "email": "username@example.com",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| email required | string |
| newPassword required | string |
| email required | string |
| updatedAt required | string |
| enable required | boolean |
{- "email": "user@example.com",
- "newPassword": "New$tr0ngP@sSw0rd!"
}{- "email": "username@example.com",
- "updatedAt": "2023-05-10T03:07:20.393Z",
- "enable": "true"
}| name required | string |
| workspaces required | Array of strings |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| apikey | string |
{- "name": "account name",
- "workspaces": "2a441200-eece-11ed-a05b-0242ac120003",
- "permission": 2,
- "apikey": "string"
}| name required | string |
| workspaces required | Array of strings |
| permission required | number LV 1 - 5, LV 1 has highest permission |
| apikey | string |
{- "name": "account name",
- "workspaces": "2a441200-eece-11ed-a05b-0242ac120003",
- "permission": 2,
- "apikey": "string"
}| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| id required | number |
| fields | Array of strings Selects resource fields. Docs |
| join | Array of strings Adds relational resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
{ }| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Groups) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}| fields | Array of strings Selects resource fields. Docs |
| s | string Adds search condition. Docs |
| filter | Array of strings Adds filter condition. Docs |
| or | Array of strings Adds OR condition. Docs |
| sort | Array of strings Adds sort by field. Docs |
| join | Array of strings Adds relational resources. Docs |
| limit | integer Limit amount of resources. Docs |
| offset | integer Offset amount of resources. Docs |
| page | integer Page portion of resources. Docs |
| cache | integer [ 0 .. 1 ] Reset cache (if was enabled). Docs |
| data required | Array of objects (Groups) |
| count required | number |
| total required | number |
| page required | number |
| pageCount required | number |
{- "data": [
- { }
], - "count": 0,
- "total": 0,
- "page": 0,
- "pageCount": 0
}