Permissions
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
Authorizations
Responses
200
OK
get
GET /v1/permissions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
OK
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionName": "text",
"Description": "text"
}
]
Authorizations
Body
Representing a permission in the system
Uidstring · uuidOptional
Unique id of permission
PermissionGroupUidstring · uuidOptional
Uid of group to place permission in
PermissionNamestring | nullableOptional
Name of permission
Descriptionstring | nullableOptional
Description of permission
Responses
200
OK
post
POST /v1/permissions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 151
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionName": "text",
"Description": "text"
}
200
OK
No content
Authorizations
Body
Representing a permission in the system
Uidstring · uuidOptional
Unique id of permission
PermissionGroupUidstring · uuidOptional
Uid of group to place permission in
PermissionNamestring | nullableOptional
Name of permission
Descriptionstring | nullableOptional
Description of permission
Responses
200
OK
put
PUT /v1/permissions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 151
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionName": "text",
"Description": "text"
}
200
OK
No content
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
404
Not Found
get
GET /v1/permissions/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"PermissionName": "text",
"Description": "text"
}
Authorizations
Body
Represents a group of permissions
Uidstring · uuidOptional
Unique id of permission group
Namestring | nullableOptional
Name of permission group
Responses
200
OK
post
POST /v1/permissiongroups HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
200
OK
No content
Authorizations
Body
Represents a group of permissions
Uidstring · uuidOptional
Unique id of permission group
Namestring | nullableOptional
Name of permission group
Responses
200
OK
put
PUT /v1/permissiongroups HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
200
OK
No content