editWebUICertificate

The editWebUICertificate operation handles configuration related to WebUICertificate model.

Description

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

The certificate specified in the request's body will replace the current certificate on the server. If the certificate is self-signed the user will need to accept a new security exception the next time that they access the UI.

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 that represents the name of the object
certificate	True	object	A mandatory Internal Certificate object, used for HTTPS communication. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [InternalCertificate]
trustChain	False	[object]	A set containing all intermediate certificates and the root certificate, used to verify the certificate chain. The certificates do not need to be in order. At a minimum, each certificate must contain the certificate string itself, the subject name, and the issuer name. Allowed types are: [ExternalCACertificate]
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 'editWebUICertificate' operation
  ftd_configuration:
    operation: "editWebUICertificate"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        certificate: "{{ certificate }}"
        trustChain: "{{ trust_chain }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"