getUserList

The getUserList operation handles configuration related to User model.

Query Parameters

Parameter	Required	Type	Description
offset	False	integer	An integer representing the index of the first requested object. Index starts from 0. If not specified, the returned objects will start from index 0
limit	False	integer	An integer representing the maximum amount of objects to return. If not specified, the maximum amount is 10
sort	False	string	The field used to sort the requested object list
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {field}{operator}{value}[;{field}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported fields are: "name".

Example

- name: Execute 'getUserList' operation
  ftd_configuration:
    operation: "getUserList"
    query_params:
        offset: "{{ offset }}"
        limit: "{{ limit }}"
        sort: "{{ sort }}"
        filter: "{{ filter }}"