Jump to

• Request
• Response

Create a User Group

post

/api/AAA/UserGroups

Creates a new user group.
The minimum required properties in the request body are:

• UserGroupName
• RoleID
• Users
• Properties
• Preferences

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Details of the user group to create or update.

Show Source

• Preferences: array Preferences
  The user group preferences.
• Properties: array Properties
  The user group properties.
• RoleID: integer
  The role ID.

  Example: 1
• UserGroupName: string
  The user group 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: Administrators
• Users: array Users
  The IDs of the users in the group.

{
    "properties":{
        "UserGroupName":{
            "description":"The user group name.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Administrators"
        },
        "RoleID":{
            "description":"The role ID.",
            "type":"integer",
            "example":"1"
        },
        "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 property description.",
                        "type":"string",
                        "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups"
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user group preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"2"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"PageSize"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"integer",
                        "example":"1000"
                    },
                    "Description":{
                        "description":"The description of the preference.",
                        "type":"string",
                        "example":"Default pagination setting for grid views (default 1000)"
                    },
                    "Required":{
                        "description":"Whether the field is required (<b>true</b>) or not (<b>false</b>).",
                        "type":"boolean",
                        "example":"false"
                    },
                    "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":"1"
                    }
                }
            }
        },
        "Users":{
            "description":"The IDs of the users in the group.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1065
            ]
        }
    },
    "type":"object",
    "description":"Details of the user group to create or update."
}

Nested Schema : Preferences

Type: array

The user group preferences.

Show Source

• Array of: object items

{
    "description":"The user group preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"2"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"PageSize"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"integer",
                "example":"1000"
            },
            "Description":{
                "description":"The description of the preference.",
                "type":"string",
                "example":"Default pagination setting for grid views (default 1000)"
            },
            "Required":{
                "description":"Whether the field is required (<b>true</b>) or not (<b>false</b>).",
                "type":"boolean",
                "example":"false"
            },
            "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":"1"
            }
        }
    }
}

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 property description.",
                "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 IDs of the users in the group.

Show Source

• Array of: integer

{
    "description":"The IDs of the users in the group.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1065
    ]
}

Example:

[
    1065
]

Nested Schema : items

Type: object

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: 1
• PreferenceID: integer
  The preference ID.

  Example: 2
• PreferenceName: string
  The preference name.

  Example: PageSize
• PreferenceValue: integer
  The preference value.

  Example: 1000
• Required: boolean
  Whether the field is required (true) or not (false).

  Example: false

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"2"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"PageSize"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"integer",
            "example":"1000"
        },
        "Description":{
            "description":"The description of the preference.",
            "type":"string",
            "example":"Default pagination setting for grid views (default 1000)"
        },
        "Required":{
            "description":"Whether the field is required (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "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":"1"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The property description.

  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 property description.",
            "type":"string",
            "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "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 : SuccessfulAddOperation

Type: object

The 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

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "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

Body ()

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.

Back to Top