editDuoLDAPIdentitySource

The editDuoLDAPIdentitySource operation handles configuration related to DuoLDAPIdentitySource 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	The name of the Identity Source
description	False	string	Description for this Duo LDAP Object Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
apiHostname	True	string	Hostname of the Duo LDAP server. This is the API hostname you obtain from your Duo account. The name starts with api- and ends with .duosecurity.com. Field level constraints: cannot be null, must be a valid host (FQDN or IP) or a list of valid hosts. (Note: Additional constraints might exist)
port	True	integer	The normal port is 636. Field level constraints: cannot be null, must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
timeout	False	integer	Timeout in seconds to connect to Duo. The default timeout is 120 seconds while the minimum timeout is 1 second and the max timeout is 300 seconds. Field level constraints: must be between 1 and 300 (inclusive). (Note: Additional constraints might exist)
integrationKey	True	string	The Duo integration key. Obtain this key from your Duo account. Field level constraints: cannot be null, must match pattern ^[A-Z0-9]+$, length must be between 20 and 20 (inclusive). (Note: Additional constraints might exist)
secretKey	True	string	Secret key for Duo. Obtain this key from your Duo account. 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)
interface	False	object	Interface to connect to Duo, or null. If you do not specify an interface, the system uses the routing table to find the right interface. Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
type	True	string	duoldapidentitysource

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editDuoLDAPIdentitySource' operation
  ftd_configuration:
    operation: "editDuoLDAPIdentitySource"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        apiHostname: "{{ api_hostname }}"
        port: "{{ port }}"
        timeout: "{{ timeout }}"
        integrationKey: "{{ integration_key }}"
        secretKey: "{{ secret_key }}"
        id: "{{ id }}"
        interface: "{{ interface }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"