editAAASetting

The editAAASetting operation handles configuration related to AAASetting 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	False	string	A read-only string specifying the name of the rule.
identitySourceGroup	True	object	Reference to a AAA Identity Source group object. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [ActiveDirectoryRealm, DuoLDAPIdentitySource, IdentitySourceBase, LDAPRealm, LocalIdentitySource, RadiusIdentitySource, RadiusIdentitySourceGroup, RealmSequence, SAMLServer, SpecialRealm]
description	False	string	This referenced identity source group object will be used for the external authentication of the specified connection type Field level constraints: must match pattern ^((?!;).)*$, length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
protocolType	True	string	A read-only enum that defines the protocol type for the AAA Identity Source. The default value is HTTPS. The possible values for this object are: HTTPS SSH Field level constraints: cannot be null. (Note: Additional constraints might exist)
useLocal	True	string	An enum that specifies the order in which the system will use local authentication if the identity sources are unreachable. If the rule's identity source group is set to local, then this field should be set to NOT_APPLICABLE. Otherwise, the field should be set to either BEFORE, AFTER, or NEVER. Field level constraints: cannot be null. (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.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editAAASetting' operation
  ftd_configuration:
    operation: "editAAASetting"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        identitySourceGroup: "{{ identity_source_group }}"
        description: "{{ description }}"
        protocolType: "{{ protocol_type }}"
        useLocal: "{{ use_local }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"