| UserGetResult | user.Get | Returns a filtered list of User Objects. Only for the UI the users will contain the password property though. |
| mode | DataMode | (Optional) View of the objects to return: raw or effective. Default is effective. |
| include | DataMode | (Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). |
| filter | DataFilter | (Optional) Filter definition which determines the result set. |
| sort | DataSortItem[] | (Optional) Sorting definition as a list of properties with order. |
| offset | int | (Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination. |
| limit | int | (Optional) Maximum amount of Objects that should be returned. (Max : 100000) |
| select | string[] | (Optional) List of properties that should be contained in the result objects. |
| UserGetResult | user.GetNext | Returns a filtered list of User Objects as a follow up to a previous Get call. Only for the UI the users will contain the password property though. |
| context | string | The context received within the last get result. Mandatory for subsequent get calls with pagination. |
| scroll | PaginationScroll | (Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. |
| offset | int | (Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination. |
| limit | int | (Optional) Maximum amount of Objects that should be returned. (Max : 100000) |
| User | user.GetOne | Returns a single User Object identified by the given id. Only for the UI it will contain the password property though. |
| id | guid | The User's id. |
| mode | DataMode | (Optional) View of the object to return: raw or effective. Default is effective. |
| include | DataMode | (Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). |
| select | string[] | (Optional) List of properties that should be contained in the result object. |
| guid | user.Create | Creates the User in the system and returns the id of the User. When the User does not have an id a new one is created. If a User with the same id already exists the new one is not saved and an empty id is returned. Currently only accessible by the UI. |
| object | UserRaw | The User to create. |
| bool | user.Update | Updates a User with data from the provided Object. Currently only accessible by the UI. |
| id | guid | Id of the User to update. |
| object | UserRaw | User to update |
| bool | user.Set | Sets specific properties of a User Object. Currently only accessible by the UI. |
| id | guid | Id of the User to modify. |
| props | value{} | List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object. |
| bool | user.Delete | Deletes a User Object. Returns true if successfully deleted or if no such Object existed to begin with. Currently only accessible by the UI. |
| id | guid | Id of the User to delete. |
| bool | user.BulkModify | Performs a bulk of changes at once. Currently only accessible by the UI. |
| create | UserRaw[] | (Optional) List of User Objects to create. |
| update | UserRaw[] | (Optional) List of User Objects to update. |
| set | ObjectAspect[] | (Optional) List of User Object properties to set. |
| delete | guid[] | (Optional) List of User ids to delete. |