REST API for Unified Assurance Core

Get Roles

get

/api/AAA/Roles

Gets the roles that match the specified parameters. If no parameters are specified, all roles are returned.

Request

Query Parameters

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{ "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAARolesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAARolesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object AAARolesRead

Role details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAARolesRead"
    }
}

Nested Schema : AAARolesRead

Type: object

Role 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

{
    "properties":{
        "RoleID":{
            "description":"The role ID.",
            "type":"integer",
            "example":"1"
        },
        "RoleName":{
            "description":"The role name.",
            "type":"string",
            "example":"Administrator"
        },
        "Description":{
            "description":"The description of the role.",
            "type":"string",
            "example":"Administrators have complete access to all user interfaces"
        },
        "Permissions":{
            "description":"The permissions associated with the role. The <i>&lt;Operation&gt;</i><b>Available</b> properties determine whether it is possible to enable an operation for the permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the operation is enabled.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PermissionID":{
                        "description":"The permission ID.",
                        "type":"integer",
                        "example":"10001"
                    },
                    "PermissionName":{
                        "description":"The permission name.",
                        "type":"string",
                        "example":"SUPER"
                    },
                    "PackageName":{
                        "description":"The package name.",
                        "type":"string",
                        "example":"global"
                    },
                    "ReadAvailable":{
                        "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateAvailable":{
                        "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateAvailable":{
                        "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteAvailable":{
                        "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteAvailable":{
                        "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "Description":{
                        "description":"The description of the permission.",
                        "type":"string",
                        "example":"Assigns administrative rights to view and modify items even if not the owner"
                    },
                    "ReadFlag":{
                        "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateFlag":{
                        "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateFlag":{
                        "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteFlag":{
                        "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteFlag":{
                        "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        }
    },
    "type":"object",
    "description":"Role details."
}

Nested Schema : Permissions

Type: array

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.

Show Source

Array of: object items

{
    "description":"The permissions associated with the role. The <i>&lt;Operation&gt;</i><b>Available</b> properties determine whether it is possible to enable an operation for the permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the operation is enabled.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PermissionID":{
                "description":"The permission ID.",
                "type":"integer",
                "example":"10001"
            },
            "PermissionName":{
                "description":"The permission name.",
                "type":"string",
                "example":"SUPER"
            },
            "PackageName":{
                "description":"The package name.",
                "type":"string",
                "example":"global"
            },
            "ReadAvailable":{
                "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateAvailable":{
                "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateAvailable":{
                "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteAvailable":{
                "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteAvailable":{
                "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "Description":{
                "description":"The description of the permission.",
                "type":"string",
                "example":"Assigns administrative rights to view and modify items even if not the owner"
            },
            "ReadFlag":{
                "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateFlag":{
                "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateFlag":{
                "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteFlag":{
                "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteFlag":{
                "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PermissionID":{
            "description":"The permission ID.",
            "type":"integer",
            "example":"10001"
        },
        "PermissionName":{
            "description":"The permission name.",
            "type":"string",
            "example":"SUPER"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"global"
        },
        "ReadAvailable":{
            "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateAvailable":{
            "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateAvailable":{
            "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteAvailable":{
            "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteAvailable":{
            "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "Description":{
            "description":"The description of the permission.",
            "type":"string",
            "example":"Assigns administrative rights to view and modify items even if not the owner"
        },
        "ReadFlag":{
            "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateFlag":{
            "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateFlag":{
            "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteFlag":{
            "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteFlag":{
            "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.