#Security

Use security endpoint to manage permissions and security settings in the system programmically. 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
Name string

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
Name string

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
Name string

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
Name string

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
PermissionGroupUid string
Alias string
PermissionName string
Description string

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
PermissionGroupUid string
Alias string
PermissionName string
Description string

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
PermissionGroupUid string
Alias string
PermissionName string
Description string

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
PermissionGroupUid string
Alias string
PermissionName string
Description string

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