fortios_system_sso_admin – Configure SSO admin users in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


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


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

  • ansible>=2.14


Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges
fortios_system_sso_admin v6.2.0 -> latest


  • 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_sso_admin - Configure SSO admin users. type: dict more...
    • accprofile - SSO admin user access profile. Source type: str more...
    • gui_dashboard - GUI dashboards. type: list member_path: gui_dashboard:id more...
      • columns - Number of columns. type: int more...
      • id - Dashboard ID. see Notes. type: int required: true more...
      • layout_type - Layout type. type: str choices: responsive, fixed more...
      • name - Dashboard name. type: str more...
      • permanent - Permanent dashboard (can"t be removed via the GUI). type: str choices: disable, enable more...
      • vdom - Virtual domain. Source type: str more...
      • widget - Dashboard widgets. type: list member_path: gui_dashboard:id/widget:id more...
        • fabric_device - Fabric device to monitor. type: str more...
        • fabric_device_widget_name - Fabric device widget name. type: str more...
        • fabric_device_widget_visualization_type - Visualization type for fabric device widget. type: str more...
        • fortiview_device - FortiView device. type: str more...
        • fortiview_filters - FortiView filters. type: list member_path: gui_dashboard:id/widget:id/fortiview_filters:id more...
          • id - FortiView Filter ID. see Notes. type: int required: true more...
          • key - Filter key. type: str more...
          • value - Filter value. type: str more...
        • fortiview_sort_by - FortiView sort by. type: str more...
        • fortiview_timeframe - FortiView timeframe. type: str more...
        • fortiview_type - FortiView type. type: str more...
        • fortiview_visualization - FortiView visualization. type: str more...
        • height - Height. type: int more...
        • id - Widget ID. see Notes. type: int required: true more...
        • industry - Security Audit Rating industry. type: str choices: default, custom more...
        • interface - Interface to monitor. Source type: str more...
        • region - Security Audit Rating region. type: str choices: default, custom more...
        • title - Widget title. type: str more...
        • type - Widget type. type: str choices: sysinfo, licinfo, forticloud, cpu-usage, memory-usage, disk-usage, log-rate, sessions, session-rate, tr-history, analytics, usb-modem, admins, security-fabric, security-fabric-ranking, sensor-info, ha-status, vulnerability-summary, host-scan-summary, fortiview, botnet-activity, fabric-device more...
        • width - Width. type: int more...
        • x_pos - X position. type: int more...
        • y_pos - Y position. type: int more...
    • gui_global_menu_favorites - Favorite GUI menu IDs for the global VDOM. type: list member_path: gui_global_menu_favorites:id more...
      • id - Select menu ID. type: str required: true more...
    • gui_ignore_release_overview_version - The FortiOS version to ignore release overview prompt for. type: str more...
    • gui_new_feature_acknowledge - Acknowledgement of new features. type: list member_path: gui_new_feature_acknowledge:id more...
      • id - Select menu ID. type: str required: true more...
    • gui_vdom_menu_favorites - Favorite GUI menu IDs for VDOMs. type: list member_path: gui_vdom_menu_favorites:id more...
      • id - Select menu ID. type: str required: true more...
    • name - SSO admin name. type: str required: true more...
    • vdom - Virtual domain(s) that the administrator can access. type: list member_path: vdom:name more...
      • name - Virtual domain name. Source type: str required: true more...



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


- name: Configure SSO admin users.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          accprofile: "<your_own_value> (source"
                  columns: "10"
                  id: "6"
                  layout_type: "responsive"
                  name: "default_name_8"
                  permanent: "disable"
                  vdom: "<your_own_value> (source"
                          fabric_device: "<your_own_value>"
                          fabric_device_widget_name: "<your_own_value>"
                          fabric_device_widget_visualization_type: "<your_own_value>"
                          fortiview_device: "<your_own_value>"
                                  id: "17"
                                  key: "<your_own_value>"
                                  value: "<your_own_value>"
                          fortiview_sort_by: "<your_own_value>"
                          fortiview_timeframe: "<your_own_value>"
                          fortiview_type: "<your_own_value>"
                          fortiview_visualization: "<your_own_value>"
                          height: "25"
                          id: "25"
                          industry: "default"
                          interface: "<your_own_value> (source"
                          region: "default"
                          title: "<your_own_value>"
                          type: "sysinfo"
                          width: "25"
                          x_pos: "500"
                          y_pos: "500"
                  id: "35"
          gui_ignore_release_overview_version: "<your_own_value>"
                  id: "38"
                  id: "40"
          name: "default_name_41"
                  name: "default_name_43 (source"

Return Values

Common return values are documented:, 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:
  • 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


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


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


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