REST API for Unified Assurance Core

Get User Groups

get

/api/AAA/UserGroups

Gets the user groups that match the specified parameters. If no parameters are specified, all user groups 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/AAAUserGroupsRead"
                    }
                }
            }
        }
    ]
}

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/AAAUserGroupsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object AAAUserGroupsRead

User group details.

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

Nested Schema : AAAUserGroupsRead

Type: object

User group details.

Show Source

Preferences: array Preferences

The user group preferences.
Properties: array Properties

The user group properties.
RoleID: integer

The role ID.

Example: 1
RoleName: string

The role name.

Example: Administrator
UserGroupID: integer

The user group ID.

Example: 1
UserGroupName: string

The user group name.

Example: Administrators
Users: array Users

The users in the group.

{
    "properties":{
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "RoleID":{
            "description":"The role ID.",
            "type":"integer",
            "example":"1"
        },
        "RoleName":{
            "description":"The role name.",
            "type":"string",
            "example":"Administrator"
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer",
            "example":"1"
        },
        "Preferences":{
            "description":"The user group preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "description":"A preference.",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"2"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"PageSize"
                    },
                    "Description":{
                        "description":"The description of the preference.",
                        "type":"string",
                        "example":"Default pagination setting for grid views (default 1000)"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"integer",
                        "example":"1000"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>) to allow users to override the group preference or locked (<b>1</b>) to prevent users from overriding it.",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        },
        "Properties":{
            "description":"The user group properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"RestrictiveDeviceGroupID"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"integer",
                        "example":"1"
                    },
                    "Description":{
                        "description":"The description of the property.",
                        "type":"string",
                        "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups"
                    }
                }
            }
        },
        "Users":{
            "description":"The users in the group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserID":{
                        "description":"The user ID.",
                        "type":"integer",
                        "example":"1065"
                    },
                    "UserName":{
                        "description":"The user name.",
                        "type":"string",
                        "example":"Operator"
                    }
                }
            }
        }
    },
    "type":"object",
    "description":"User group details."
}

Nested Schema : Preferences

Type: array

The user group preferences.

Show Source

Array of: object items

A preference.

{
    "description":"The user group preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "description":"A preference.",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"2"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"PageSize"
            },
            "Description":{
                "description":"The description of the preference.",
                "type":"string",
                "example":"Default pagination setting for grid views (default 1000)"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"integer",
                "example":"1000"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>) to allow users to override the group preference or locked (<b>1</b>) to prevent users from overriding it.",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user group properties.

Show Source

Array of: object items

{
    "description":"The user group properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"RestrictiveDeviceGroupID"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"integer",
                "example":"1"
            },
            "Description":{
                "description":"The description of the property.",
                "type":"string",
                "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups"
            }
        }
    }
}

Nested Schema : Users

Type: array

The users in the group.

Show Source

Array of: object items

{
    "description":"The users in the group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserID":{
                "description":"The user ID.",
                "type":"integer",
                "example":"1065"
            },
            "UserName":{
                "description":"The user name.",
                "type":"string",
                "example":"Operator"
            }
        }
    }
}

Nested Schema : items

Type: object

A preference.

Show Source

Description: string

The description of the preference.

Example: Default pagination setting for grid views (default 1000)
Override: integer

Whether the preference is unlocked (0) to allow users to override the group preference or locked (1) to prevent users from overriding it.

Example: 0
PreferenceID: integer

The preference ID.

Example: 2
PreferenceName: string

The preference name.

Example: PageSize
PreferenceValue: integer

The preference value.

Example: 1000

{
    "type":"object",
    "description":"A preference.",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"2"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"PageSize"
        },
        "Description":{
            "description":"The description of the preference.",
            "type":"string",
            "example":"Default pagination setting for grid views (default 1000)"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"integer",
            "example":"1000"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>) to allow users to override the group preference or locked (<b>1</b>) to prevent users from overriding it.",
            "type":"integer",
            "example":"0"
        }
    }
}

Nested Schema : items

Type: object

Show Source

Description: string

The description of the property.

Example: Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups
PropertyID: integer

The property ID.

Example: 1
PropertyName: string

The property name.

Example: RestrictiveDeviceGroupID
PropertyValue: integer

The property value.

Example: 1

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"RestrictiveDeviceGroupID"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"integer",
            "example":"1"
        },
        "Description":{
            "description":"The description of the property.",
            "type":"string",
            "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups"
        }
    }
}

Nested Schema : items

Type: object

Show Source

UserID: integer

The user ID.

Example: 1065
UserName: string

The user name.

Example: Operator

{
    "type":"object",
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1065"
        },
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"Operator"
        }
    }
}

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.