#!/usr/bin/python from __future__ import absolute_import, division, print_function # Copyright 2019-2024 Fortinet, Inc. # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) __metaclass__ = type ANSIBLE_METADATA = {'status': ['preview'], 'supported_by': 'community', 'metadata_version': '1.1'} DOCUMENTATION = ''' --- module: fmgr_system_saml short_description: Global settings for SAML authentication. description: - This module is able to configure a FortiManager device. - Examples include all parameters and values which need to be adjusted to data sources before usage. version_added: "2.0.0" author: - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu) notes: - Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as "var-name" to "var_name". Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg. - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded options: access_token: description: The token to access FortiManager without using username and password. type: str bypass_validation: description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool default: false enable_log: description: Enable/Disable logging for task. type: bool default: false forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str proposed_method: description: The overridden method for the underlying Json RPC request. type: str choices: - update - set - add rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. type: list elements: int rc_failed: description: The rc codes list with which the conditions to fail will be overriden. type: list elements: int workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str workspace_locking_timeout: description: The maximum time in seconds to wait for other user to release the workspace lock. type: int default: 300 system_saml: description: The top level parameters set. required: false type: dict suboptions: acs_url: aliases: ['acs-url'] type: str description: SP ACS cert: type: str description: Certificate name. entity_id: aliases: ['entity-id'] type: str description: SP entity ID. idp_cert: aliases: ['idp-cert'] type: str description: IDP Certificate name. idp_entity_id: aliases: ['idp-entity-id'] type: str description: IDP entity ID. idp_single_logout_url: aliases: ['idp-single-logout-url'] type: str description: IDP single logout url. idp_single_sign_on_url: aliases: ['idp-single-sign-on-url'] type: str description: IDP single sign-on URL. login_auto_redirect: aliases: ['login-auto-redirect'] type: str description: - Enable/Disable auto redirect to IDP login page. - disable - Disable auto redirect to IDP Login Page. - enable - Enable auto redirect to IDP Login Page. choices: - 'disable' - 'enable' role: type: str description: - SAML role. - IDP - IDentiy Provider. - SP - Service Provider. choices: - 'IDP' - 'SP' - 'FAB-SP' server_address: aliases: ['server-address'] type: str description: Server address. service_providers: aliases: ['service-providers'] type: list elements: dict description: Service providers. suboptions: idp_entity_id: aliases: ['idp-entity-id'] type: str description: IDP Entity ID. idp_single_logout_url: aliases: ['idp-single-logout-url'] type: str description: IDP single logout url. idp_single_sign_on_url: aliases: ['idp-single-sign-on-url'] type: str description: IDP single sign-on URL. name: type: str description: Name. prefix: type: str description: Prefix. sp_cert: aliases: ['sp-cert'] type: str description: SP certificate name. sp_entity_id: aliases: ['sp-entity-id'] type: str description: SP Entity ID. sp_single_logout_url: aliases: ['sp-single-logout-url'] type: str description: SP single logout URL. sp_single_sign_on_url: aliases: ['sp-single-sign-on-url'] type: str description: SP single sign-on URL. sp_adom: aliases: ['sp-adom'] type: str description: SP adom name. sp_profile: aliases: ['sp-profile'] type: str description: SP profile name. sls_url: aliases: ['sls-url'] type: str description: SP SLS status: type: str description: - Enable/disable SAML authentication - disable - Disable SAML authentication. - enable - Enabld SAML authentication. choices: - 'disable' - 'enable' default_profile: aliases: ['default-profile'] type: str description: Default Profile Name. fabric_idp: aliases: ['fabric-idp'] type: list elements: dict description: Fabric idp. suboptions: dev_id: aliases: ['dev-id'] type: str description: IDP Device ID. idp_cert: aliases: ['idp-cert'] type: str description: IDP Certificate name. idp_entity_id: aliases: ['idp-entity-id'] type: str description: IDP entity ID. idp_single_logout_url: aliases: ['idp-single-logout-url'] type: str description: IDP single logout url. idp_single_sign_on_url: aliases: ['idp-single-sign-on-url'] type: str description: IDP single sign-on URL. idp_status: aliases: ['idp-status'] type: str description: - Enable/disable SAML authentication - disable - Disable SAML authentication. - enable - Enabld SAML authentication. choices: - 'disable' - 'enable' forticloud_sso: aliases: ['forticloud-sso'] type: str description: - Enable/disable FortiCloud SSO - disable - Disable Forticloud SSO. - enable - Enabld Forticloud SSO. choices: - 'disable' - 'enable' user_auto_create: aliases: ['user-auto-create'] type: str description: - Enable/disable user auto creation - disable - Disable auto create user. - enable - Enable auto create user. choices: - 'disable' - 'enable' auth_request_signed: aliases: ['auth-request-signed'] type: str description: - Enable/Disable auth request signed. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' want_assertions_signed: aliases: ['want-assertions-signed'] type: str description: - Enable/Disable want assertions signed. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' ''' EXAMPLES = ''' - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Global settings for SAML authentication. fortinet.fortimanager.fmgr_system_saml: # bypass_validation: false workspace_locking_adom: workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] system_saml: # acs_url: # cert: # entity_id: # idp_cert: # idp_entity_id: # idp_single_logout_url: # idp_single_sign_on_url: # login_auto_redirect: # role: # server_address: # service_providers: # - idp_entity_id: # idp_single_logout_url: # idp_single_sign_on_url: # name: # prefix: # sp_cert: # sp_entity_id: # sp_single_logout_url: # sp_single_sign_on_url: # sp_adom: # sp_profile: # sls_url: # status: # default_profile: # fabric_idp: # - dev_id: # idp_cert: # idp_entity_id: # idp_single_logout_url: # idp_single_sign_on_url: # idp_status: # forticloud_sso: # user_auto_create: # auth_request_signed: # want_assertions_signed: ''' RETURN = ''' meta: description: The result of the request. type: dict returned: always contains: request_url: description: The full url requested. returned: always type: str sample: /sys/login/user response_code: description: The status of api request. returned: always type: int sample: 0 response_data: description: The api response. type: list returned: always response_message: description: The descriptive message of the api response. type: str returned: always sample: OK. system_information: description: The information of the target system. type: dict returned: always rc: description: The status the request. type: int returned: always sample: 0 version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. type: list returned: complex ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import Connection from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager, check_galaxy_version, check_parameter_bypass from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec def main(): urls_list = [ '/cli/global/system/saml' ] url_params = [] module_primary_key = None module_arg_spec = { 'system_saml': { 'type': 'dict', 'v_range': [['6.0.0', '']], 'options': { 'acs-url': {'type': 'str'}, 'cert': {'type': 'str'}, 'entity-id': {'type': 'str'}, 'idp-cert': {'type': 'str'}, 'idp-entity-id': {'type': 'str'}, 'idp-single-logout-url': {'type': 'str'}, 'idp-single-sign-on-url': {'type': 'str'}, 'login-auto-redirect': {'choices': ['disable', 'enable'], 'type': 'str'}, 'role': {'choices': ['IDP', 'SP', 'FAB-SP'], 'type': 'str'}, 'server-address': {'type': 'str'}, 'service-providers': { 'type': 'list', 'options': { 'idp-entity-id': {'type': 'str'}, 'idp-single-logout-url': {'type': 'str'}, 'idp-single-sign-on-url': {'type': 'str'}, 'name': {'type': 'str'}, 'prefix': {'type': 'str'}, 'sp-cert': {'type': 'str'}, 'sp-entity-id': {'type': 'str'}, 'sp-single-logout-url': {'type': 'str'}, 'sp-single-sign-on-url': {'type': 'str'}, 'sp-adom': {'v_range': [['7.2.0', '']], 'type': 'str'}, 'sp-profile': {'v_range': [['7.2.0', '']], 'type': 'str'} }, 'elements': 'dict' }, 'sls-url': {'type': 'str'}, 'status': {'choices': ['disable', 'enable'], 'type': 'str'}, 'default-profile': {'v_range': [['6.2.5', '']], 'type': 'str'}, 'fabric-idp': { 'v_range': [['6.4.0', '']], 'type': 'list', 'options': { 'dev-id': {'v_range': [['6.4.0', '']], 'type': 'str'}, 'idp-cert': {'v_range': [['6.4.0', '']], 'type': 'str'}, 'idp-entity-id': {'v_range': [['6.4.0', '']], 'type': 'str'}, 'idp-single-logout-url': {'v_range': [['6.4.0', '']], 'type': 'str'}, 'idp-single-sign-on-url': {'v_range': [['6.4.0', '']], 'type': 'str'}, 'idp-status': {'v_range': [['6.4.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'} }, 'elements': 'dict' }, 'forticloud-sso': {'v_range': [['7.0.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'user-auto-create': {'v_range': [['7.0.1', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'auth-request-signed': {'v_range': [['7.2.3', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'want-assertions-signed': {'v_range': [['7.2.3', '']], 'choices': ['disable', 'enable'], 'type': 'str'} } } } module_option_spec = get_module_arg_spec('partial crud') module_arg_spec.update(module_option_spec) params_validation_blob = [] check_galaxy_version(module_arg_spec) module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'system_saml'), supports_check_mode=True) if not module._socket_path: module.fail_json(msg='MUST RUN IN HTTPAPI MODE') connection = Connection(module._socket_path) fmgr = NAPIManager('partial crud', module_arg_spec, urls_list, module_primary_key, url_params, module, connection, top_level_schema_name='data') fmgr.validate_parameters(params_validation_blob) fmgr.process_partial_crud() module.exit_json(meta=module.params) if __name__ == '__main__': main()