# Security

Use security endpoint to manage permissions and security settings in the system programmatically. Permissions can be created and added to resource actions to define granular permission control of what users can do in the system

GET /security/permissiongroups Get all permission groups added to the system

Response status OK (200)

array : PermissionGroupModel
PermissionGroupModel
Property name Data type Description
Uid string

Unique id of permission group

Name string

Name of permission group

IsSystemPermissionGroup boolean

Is system permission group (readonly)


PUT /security/permissiongroups Update a permission group

Request parameters

Property name Parameter type Data type Description
model body object : PermissionGroupModel
PermissionGroupModel
Property name Data type Description
Uid string

Unique id of permission group

Name string

Name of permission group

IsSystemPermissionGroup boolean

Is system permission group (readonly)

Response status OK (200)

No body message is returned

POST /security/permissiongroups Add permission group to system

Request parameters

Property name Parameter type Data type Description
model body object : PermissionGroupModel
PermissionGroupModel
Property name Data type Description
Uid string

Unique id of permission group

Name string

Name of permission group

IsSystemPermissionGroup boolean

Is system permission group (readonly)

Response status OK (200)

No body message is returned

GET /security/permissiongroups/{uid} Get a specific permission group

Request parameters

Property name Parameter type Data type Description
uid path string

Response status OK (200)

object : PermissionGroupModel
PermissionGroupModel
Property name Data type Description
Uid string

Unique id of permission group

Name string

Name of permission group

IsSystemPermissionGroup boolean

Is system permission group (readonly)


DELETE /security/permissiongroups/{uid} Delete a permission group

Request parameters

Property name Parameter type Data type Description
uid path string

the Unique id of the permission group

Response status OK (200)

No body message is returned

GET /security/permissions Get all permissions added to the system

Response status OK (200)

array : PermissionModel
PermissionModel
Property name Data type Description
Uid string

Unique id of permission

PermissionGroupUid string

Uid of group to place permission in

PermissionName string

Name of permission

Description string

Description of permission

IsSystemPermission boolean

Is system permission (readonly)


PUT /security/permissions Update a permission

Request parameters

Property name Parameter type Data type Description
model body object : PermissionModel
PermissionModel
Property name Data type Description
Uid string

Unique id of permission

PermissionGroupUid string

Uid of group to place permission in

PermissionName string

Name of permission

Description string

Description of permission

IsSystemPermission boolean

Is system permission (readonly)

Response status OK (200)

No body message is returned

POST /security/permissions Add permission to system

Request parameters

Property name Parameter type Data type Description
model body object : PermissionModel
PermissionModel
Property name Data type Description
Uid string

Unique id of permission

PermissionGroupUid string

Uid of group to place permission in

PermissionName string

Name of permission

Description string

Description of permission

IsSystemPermission boolean

Is system permission (readonly)

Response status OK (200)

No body message is returned

GET /security/permissions/{uid} Get a specific permission

Request parameters

Property name Parameter type Data type Description
uid path string

Response status OK (200)

object : PermissionModel
PermissionModel
Property name Data type Description
Uid string

Unique id of permission

PermissionGroupUid string

Uid of group to place permission in

PermissionName string

Name of permission

Description string

Description of permission

IsSystemPermission boolean

Is system permission (readonly)


DELETE /security/permissions/{uid} Delete a permission

Request parameters

Property name Parameter type Data type Description
uid path string

the Unique id of the permission

Response status OK (200)

No body message is returned

GET /security/usergroups Get all user groups added to the system

Response status OK (200)

array : UserGroupModel
UserGroupModel
Property name Data type Description
Id string
Name string

PUT /security/usergroups Update a user group

Request parameters

Property name Parameter type Data type Description
model body object : UserGroupModel
UserGroupModel
Property name Data type Description
Id string
Name string

Response status OK (200)

No body message is returned

POST /security/usergroups Add user group to system

Request parameters

Property name Parameter type Data type Description
model body object : CreateUserGroupModel
CreateUserGroupModel
Property name Data type Description
Alias string
Name string

Response status OK (200)

No body message is returned

GET /security/usergroups/{id} Get a specific user group

Request parameters

Property name Parameter type Data type Description
id path integer

Response status OK (200)

object : UserGroupModel
UserGroupModel
Property name Data type Description
Id string
Name string

DELETE /security/usergroups/{id} Delete a user group

Request parameters

Property name Parameter type Data type Description
id path integer

the id of the user group

Response status OK (200)

No body message is returned

GET /security/users Get all users added to the system

Response status OK (200)

array : UserModel
UserModel
Property name Data type Description
Id integer
Name string
Username string
Email string
Groups array
IsApproved boolean

PUT /security/users Update a user

Request parameters

Property name Parameter type Data type Description
model body object : UserModel
UserModel
Property name Data type Description
Id integer
Name string
Username string
Email string
Groups array
IsApproved boolean

Response status OK (200)

No body message is returned

POST /security/users Add user to system

Request parameters

Property name Parameter type Data type Description
model body object : CreateUserModel
CreateUserModel
Property name Data type Description
Name string
Username string
Email string
Groups array

Response status OK (200)

No body message is returned

GET /security/users/{id} Get a specific user

Request parameters

Property name Parameter type Data type Description
id path string

Response status OK (200)

object : UserModel
UserModel
Property name Data type Description
Id integer
Name string
Username string
Email string
Groups array
IsApproved boolean

DELETE /security/users/{id} Delete a user

Request parameters

Property name Parameter type Data type Description
id path integer

the id of the user

Response status OK (200)

No body message is returned