upsertUser

The upsertUser operation handles configuration related to User model.

Description

This API call is not allowed on the standby unit in an HA pair.

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	True	string	A String representing the current user
password	False	string	The current password. It is only used when updating user password
newPassword	False	string	The new password to use. It is only used when updating user password
userPreferences	False	object	An Object representing the timezone, UI theme selected by user
userRole	False	string	The name of the UserRole object that defines the user role (permissions) for this user. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
identitySourceId	True	string	The ID of the IdentitySource the user is associated with. Field level constraints: cannot be blank or empty, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
userServiceTypes	True	[object]	Configure the level of access using the service-type. This is an enum value and api consumer can choose from MGMT and RA_VPN Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist)
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 ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	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	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. 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 }}"
        userRole: "{{ user_role }}"
        identitySourceId: "{{ identity_source_id }}"
        userServiceTypes: "{{ user_service_types }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"