cisco.meraki_rm.meraki_organization

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki organization SAML SSO settings (singleton per organization).
GET/PUT /organizations/{organizationId}/saml
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

SAML settings configuration (singleton).

consumer_url (str)

URL consuming SAML Identity Provider (IdP).

enabled (bool)

Whether SAML SSO is enabled.

slo_logout_url (str)

URL for redirect on sign out.

sp_initiated (dict)

SP-Initiated SSO settings.

sso_login_url (str)

URL for redirect to log in again when session expires.

vision_consumer_url (str)

URL consuming SAML IdP for Meraki Vision Portal.

x509cert_sha1_fingerprint (str)

SHA1 fingerprint of the SAML certificate from IdP.

organization_id (str) required

The organization ID.

state (str)

mergedreplacedgathered

The state of the resource.

Sample Task

A template task showing all available parameters with their defaults or example values.

- name: Meraki Organization Saml task
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "organization_id_value"
    config:
      - consumer_url: "https://example.com"
        enabled: true
        slo_logout_url: "https://example.com"
        sp_initiated: {}
        sso_login_url: "https://example.com"
        vision_consumer_url: "https://example.com"
        x509cert_sha1_fingerprint: "x509cert_sha1_fingerprint_value"
    state: merged

- name: Meraki Organization Saml task
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "organization_id_value"
    config:  # optional
      - consumer_url: "https://example.com"  # optional
        enabled: true  # optional
        slo_logout_url: "https://example.com"  # optional
        sp_initiated: {}  # optional
        sso_login_url: "https://example.com"  # optional
        vision_consumer_url: "https://example.com"  # optional
        x509cert_sha1_fingerprint: "x509cert_sha1_fingerprint_value"  # optional
    state: merged  # optional

- name: Meraki Organization Saml task
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "organization_id_value"  # (str, required) The organization ID.
    config:  # (list, optional) SAML settings configuration (singleton).
      - consumer_url: "https://example.com"  # (str, optional) URL consuming SAML Identity Provider (IdP).
        enabled: true  # (bool, optional) Whether SAML SSO is enabled.
        slo_logout_url: "https://example.com"  # (str, optional) URL for redirect on sign out.
        sp_initiated: {}  # (dict, optional) SP-Initiated SSO settings.
        sso_login_url: "https://example.com"  # (str, optional) URL for redirect to log in again when session expires.
        vision_consumer_url: "https://example.com"  # (str, optional) URL consuming SAML IdP for Meraki Vision Portal.
        x509cert_sha1_fingerprint: "x509cert_sha1_fingerprint_value"  # (str, optional) SHA1 fingerprint of the SAML certificate from IdP.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: true
      consumer_url: example
      slo_logout_url: example
      sso_login_url: example
      x509cert_sha1_fingerprint: example
      vision_consumer_url: example

Create Organization_saml With Merged State

- name: Create organization_saml with merged state
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: merged
    config:
      - "{{ expected_config }}"
  register: merge_result

Assert Resource Was Created

- name: Assert resource was created
  ansible.builtin.assert:
    that:
      - merge_result is changed
      - merge_result.config | length == 1

Compare Expected Paths To Result (subset Check)

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ merge_result.config[0] | ansible.utils.to_paths }}"

Assert All Expected Fields Are Present And Match

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

Task Output:

# Manage Meraki organization SAML settings — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: false
      consumer_url: example
      slo_logout_url: example
      sso_login_url: example
      x509cert_sha1_fingerprint: example
      vision_consumer_url: example

Replace Organization_saml Configuration

- name: Replace organization_saml configuration
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: replaced
    config:
      - "{{ expected_config }}"
  register: replace_result

Assert Resource Was Replaced

- name: Assert resource was replaced
  ansible.builtin.assert:
    that:
      - replace_result is changed
      - replace_result.config | length == 1

Compare Expected Paths To Result (subset Check)

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ replace_result.config[0] | ansible.utils.to_paths }}"

Assert All Expected Fields Are Present And Match

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

Task Output:

# Manage Meraki organization SAML settings — gather current configuration

Gather Current Organization_saml Configuration

- name: Gather current organization_saml configuration
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: gathered
  register: gathered

Assert Gathered Config Is Not Empty

- name: Assert gathered config is not empty
  ansible.builtin.assert:
    that:
      - gathered.config is defined
      - gathered.config | length > 0
    fail_msg: "Gathered config is empty — expected at least one resource"

Display Gathered Configuration

- name: Display gathered configuration
  ansible.builtin.debug:
    var: gathered.config

---
# Manage Meraki organization SAML settings — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: true
      consumer_url: example
      slo_logout_url: example
      sso_login_url: example
      x509cert_sha1_fingerprint: example
      vision_consumer_url: example

- name: Create organization_saml with merged state
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: merged
    config:
      - "{{ expected_config }}"
  register: merge_result

- name: Assert resource was created
  ansible.builtin.assert:
    that:
      - merge_result is changed
      - merge_result.config | length == 1

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ merge_result.config[0] | ansible.utils.to_paths }}"

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

# Manage Meraki organization SAML settings — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: false
      consumer_url: example
      slo_logout_url: example
      sso_login_url: example
      x509cert_sha1_fingerprint: example
      vision_consumer_url: example

- name: Replace organization_saml configuration
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: replaced
    config:
      - "{{ expected_config }}"
  register: replace_result

- name: Assert resource was replaced
  ansible.builtin.assert:
    that:
      - replace_result is changed
      - replace_result.config | length == 1

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ replace_result.config[0] | ansible.utils.to_paths }}"

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

# Manage Meraki organization SAML settings — gather current configuration

- name: Gather current organization_saml configuration
  cisco.meraki_rm.meraki_organization_saml:
    organization_id: "123456"
    state: gathered
  register: gathered

- name: Assert gathered config is not empty
  ansible.builtin.assert:
    that:
      - gathered.config is defined
      - gathered.config | length > 0
    fail_msg: "Gathered config is empty — expected at least one resource"

- name: Display gathered configuration
  ansible.builtin.debug:
    var: gathered.config

Return Values

config

list — returned: always

The resulting resource configuration.