upsertUser

The upsertUser operation handles configuration related to User model.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	False	string	A String representing the current user Field level constraints: must match pattern ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
password	False	string	The current password. It is only used when updating user password Field level constraints: cannot have HTML. (Note: Additional constraints might exist)
newPassword	False	string	The new password to use. It is only used when updating user password Field level constraints: length must be between 0 and 128 (inclusive), cannot have HTML. (Note: Additional constraints might exist)
userPreferences	False	object	An Object representing the timezone, UI theme selected by user
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
type	False	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertUser' operation
  ftd_configuration:
    operation: "upsertUser"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        password: "{{ password }}"
        newPassword: "{{ new_password }}"
        userPreferences: "{{ user_preferences }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"