Skip to content

Latest commit

 

History

History
776 lines (732 loc) · 26.3 KB

fortios_user_saml.rst

File metadata and controls

776 lines (732 loc) · 26.3 KB
Raw
source

fortios_user_saml.py

orphan

fortios_user_saml -- SAML server entry configuration in Fortinet's FortiOS and FortiGate.

2.10

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and saml category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiOS Version Compatibility


v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0
fortios_user_saml yes yes yes yes yes yes yes yes

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • enable_log - Enable/Disable logging for task. type: bool required: False default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
  • user_saml - SAML server entry configuration. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>user_saml</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">adfs_claim</span> - Enable/disable ADFS Claim for user/group attribute in assertion statement . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>adfs_claim</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">cert</span> - Certificate to sign SAML messages. Source vpn.certificate.local.name. <span class="li-normal">type: str</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>cert</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">digest_method</span> - Digest Method Algorithm. . <span class="li-normal">type: str</span> <span class="li-normal">choices: sha1, sha256</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>digest_method</td> <td>yes</td> </tr> <tr> <td>[sha1]</td> <td>yes</td> </tr> <tr> <td>[sha256]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">entity_id</span> - SP entity ID. <span class="li-normal">type: str</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>entity_id</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">group_claim_type</span> - Group claim in assertion statement. <span class="li-normal">type: str</span> <span class="li-normal">choices: email, given-name, name, upn, common-name, email-adfs-1x, group, upn-adfs-1x, role, sur-name, ppid, name-identifier, authentication-method, deny-only-group-sid, deny-only-primary-sid, deny-only-primary-group-sid, group-sid, primary-group-sid, primary-sid, windows-account-name</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>group_claim_type</td> <td>yes</td> </tr> <tr> <td>[email]</td> <td>yes</td> </tr> <tr> <td>[given-name]</td> <td>yes</td> </tr> <tr> <td>[name]</td> <td>yes</td> </tr> <tr> <td>[upn]</td> <td>yes</td> </tr> <tr> <td>[common-name]</td> <td>yes</td> </tr> <tr> <td>[email-adfs-1x]</td> <td>yes</td> </tr> <tr> <td>[group]</td> <td>yes</td> </tr> <tr> <td>[upn-adfs-1x]</td> <td>yes</td> </tr> <tr> <td>[role]</td> <td>yes</td> </tr> <tr> <td>[sur-name]</td> <td>yes</td> </tr> <tr> <td>[ppid]</td> <td>yes</td> </tr> <tr> <td>[name-identifier]</td> <td>yes</td> </tr> <tr> <td>[authentication-method]</td> <td>yes</td> </tr> <tr> <td>[deny-only-group-sid]</td> <td>yes</td> </tr> <tr> <td>[deny-only-primary-sid]</td> <td>yes</td> </tr> <tr> <td>[deny-only-primary-group-sid]</td> <td>yes</td> </tr> <tr> <td>[group-sid]</td> <td>yes</td> </tr> <tr> <td>[primary-group-sid]</td> <td>yes</td> </tr> <tr> <td>[primary-sid]</td> <td>yes</td> </tr> <tr> <td>[windows-account-name]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">group_name</span> - Group name in assertion statement. <span class="li-normal">type: str</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>group_name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">idp_cert</span> - IDP Certificate name. Source vpn.certificate.remote.name. <span class="li-normal">type: str</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>idp_cert</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">idp_entity_id</span> - IDP entity ID. <span class="li-normal">type: str</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>idp_entity_id</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">idp_single_logout_url</span> - IDP single logout url. <span class="li-normal">type: str</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>idp_single_logout_url</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">idp_single_sign_on_url</span> - IDP single sign-on URL. <span class="li-normal">type: str</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>idp_single_sign_on_url</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">limit_relaystate</span> - Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>limit_relaystate</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - SAML server entry name. <span class="li-normal">type: str</span> <span class="li-required">required: True</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">single_logout_url</span> - SP single logout URL. <span class="li-normal">type: str</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>single_logout_url</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">single_sign_on_url</span> - SP single sign-on URL. <span class="li-normal">type: str</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>single_sign_on_url</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">user_claim_type</span> - User name claim in assertion statement. <span class="li-normal">type: str</span> <span class="li-normal">choices: email, given-name, name, upn, common-name, email-adfs-1x, group, upn-adfs-1x, role, sur-name, ppid, name-identifier, authentication-method, deny-only-group-sid, deny-only-primary-sid, deny-only-primary-group-sid, group-sid, primary-group-sid, primary-sid, windows-account-name</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>user_claim_type</td> <td>yes</td> </tr> <tr> <td>[email]</td> <td>yes</td> </tr> <tr> <td>[given-name]</td> <td>yes</td> </tr> <tr> <td>[name]</td> <td>yes</td> </tr> <tr> <td>[upn]</td> <td>yes</td> </tr> <tr> <td>[common-name]</td> <td>yes</td> </tr> <tr> <td>[email-adfs-1x]</td> <td>yes</td> </tr> <tr> <td>[group]</td> <td>yes</td> </tr> <tr> <td>[upn-adfs-1x]</td> <td>yes</td> </tr> <tr> <td>[role]</td> <td>yes</td> </tr> <tr> <td>[sur-name]</td> <td>yes</td> </tr> <tr> <td>[ppid]</td> <td>yes</td> </tr> <tr> <td>[name-identifier]</td> <td>yes</td> </tr> <tr> <td>[authentication-method]</td> <td>yes</td> </tr> <tr> <td>[deny-only-group-sid]</td> <td>yes</td> </tr> <tr> <td>[deny-only-primary-sid]</td> <td>yes</td> </tr> <tr> <td>[deny-only-primary-group-sid]</td> <td>yes</td> </tr> <tr> <td>[group-sid]</td> <td>yes</td> </tr> <tr> <td>[primary-group-sid]</td> <td>yes</td> </tr> <tr> <td>[primary-sid]</td> <td>yes</td> </tr> <tr> <td>[windows-account-name]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">user_name</span> - User name in assertion statement. <span class="li-normal">type: str</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>user_name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>

    Notes

    Note

    • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

    Examples

    - hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: SAML server entry configuration.
    fortios_user_saml:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_saml:
        adfs_claim: "enable"
        cert: "<your_own_value> (source vpn.certificate.local.name)"
        digest_method: "sha1"
        entity_id: "<your_own_value>"
        group_claim_type: "email"
        group_name: "<your_own_value>"
        idp_cert: "<your_own_value> (source vpn.certificate.remote.name)"
        idp_entity_id: "<your_own_value>"
        idp_single_logout_url: "<your_own_value>"
        idp_single_sign_on_url: "<your_own_value>"
        limit_relaystate: "enable"
        name: "default_name_14"
        single_logout_url: "<your_own_value>"
        single_sign_on_url: "<your_own_value>"
        user_claim_type: "email"
        user_name: "<your_own_value>"

    Return Values

    Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

    • build - Build number of the fortigate image returned: always type: str sample: 1547
    • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
    • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
    • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
    • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
    • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
    • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
    • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
    • status - Indication of the operation's result returned: always type: str sample: success
    • vdom - Virtual domain used returned: always type: str sample: root
    • version - Version of the FortiGate returned: always type: str sample: v5.6.3

    Status

    • This module is not guaranteed to have a backwards compatible interface.

    Authors

    • Link Zheng (@chillancezen)
    • Jie Xue (@JieX19)
    • Hongbin Lu (@fgtdev-hblu)
    • Frank Shen (@frankshen01)
    • Miguel Angel Munoz (@mamunozgonzalez)
    • Nicolas Thomas (@thomnico)

    Hint

    If you notice any issues in this documentation, you can create a pull request to improve it.