Create a Role
post
/api/AAA/Roles
Creates a new role.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- RoleName
- Permissions
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
objectDetails of the role to create or update.
Show Source
-
Description: string
The description of the role.Example:
Administrators have complete access to all user interfaces -
Permissions: array
Permissions
The permissions associated with the role. The <operation>Available properties determine whether it is possible to grant a permission and the <operation>Flag properties determine whether the permission is granted.
-
RoleName: string
The role name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:Administrator
Nested Schema : Permissions
Type:
arrayThe permissions associated with the role. The <operation>Available properties determine whether it is possible to grant a permission and the <operation>Flag properties determine whether the permission is granted.
Show Source
Nested Schema : items
Type:
Show Source
object-
CreateAvailable: integer
Whether the Create operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.Example:
0 -
CreateFlag: integer
Whether the role has Create access for the permission (1) or not (0).Example:
0 -
DeleteAvailable: integer
Whether the Delete operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.Example:
0 -
DeleteFlag: integer
Whether the role has Delete access for the permission (1) or not (0).Example:
0 -
Description: string
The description of the permission.Example:
Assigns administrative rights to view and modify items even if not the owner -
ExecuteAvailable: integer
Whether the Execute operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.Example:
0 -
ExecuteFlag: integer
Whether the role has Execute access for the permission (1) or not (0).Example:
0 -
PackageName: string
The package name.Example:
global -
PermissionID: integer
The permission ID.Example:
10001 -
PermissionName: string
The permission name.Example:
SUPER -
ReadAvailable: integer
Whether the Read operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.Example:
0 -
ReadFlag: integer
Whether the role has Read access for the permission (1) or not (0).Example:
0 -
UpdateAvailable: integer
Whether the Update operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.Example:
0 -
UpdateFlag: integer
Whether the role has Update access for the permission (1) or not (0).Example:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
objectThe response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record -
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAARolesRead
Type:
objectRole details.
Show Source
-
Description: string
The description of the role.Example:
Administrators have complete access to all user interfaces -
Permissions: array
Permissions
The permissions associated with the role. The <Operation>Available properties determine whether it is possible to enable an operation for the permission and the <operation>Flag properties determine whether the operation is enabled.
-
RoleID: integer
The role ID.Example:
1 -
RoleName: string
The role name.Example:
Administrator
Nested Schema : Permissions
Type:
arrayThe permissions associated with the role. The <Operation>Available properties determine whether it is possible to enable an operation for the permission and the <operation>Flag properties determine whether the operation is enabled.
Show Source
Nested Schema : items
Type:
Show Source
object-
CreateAvailable: integer
Whether the Create operation is available for the permission (1) or not (0).Example:
0 -
CreateFlag: integer
Whether the role has Create access for the permission (1) or not (0).Example:
0 -
DeleteAvailable: integer
Whether the Delete operation is available for the permission (1) or not (0).Example:
0 -
DeleteFlag: integer
Whether the role has Delete access for the permission (1) or not (0).Example:
0 -
Description: string
The description of the permission.Example:
Assigns administrative rights to view and modify items even if not the owner -
ExecuteAvailable: integer
Whether the Execute operation is available for the permission (1) or not (0).Example:
0 -
ExecuteFlag: integer
Whether the role has Execute access for the permission (1) or not (0).Example:
0 -
PackageName: string
The package name.Example:
global -
PermissionID: integer
The permission ID.Example:
10001 -
PermissionName: string
The permission name.Example:
SUPER -
ReadAvailable: integer
Whether the Read operation is available for the permission (1) or not (0).Example:
0 -
ReadFlag: integer
Whether the role has Read access for the permission (1) or not (0).Example:
0 -
UpdateAvailable: integer
Whether the Update operation is available for the permission (1) or not (0).Example:
0 -
UpdateFlag: integer
Whether the role has Update access for the permission (1) or not (0).Example:
0
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown -
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.