Organizations (Batch)

Assign SM seats to a network.

API documentation: assignOrganizationLicensesSeats

Parameters:

• organization_id (str) –

  Organization ID.

• license_id (str) –

  The ID of the SM license to assign seats from.

• network_id (str) –

  The ID of the SM network to assign the seats to.

• seat_count (int) –

  The number of seats to assign to the SM network. Must be less than or equal to the total number of seats of the license.

Assign adaptive policy groups to a policy.

API documentation: assignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroups

Parameters:

• organization_id (str) –

  Organization ID.

• policy (AssignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsPolicy) –

  Policy to assign adaptive policy groups to.

• adaptive_policy_groups (list[AssignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsAdaptivePolicyGroupsItem]) –

  Adaptive policy groups to assign.

Attach sites in this organization to Secure Access.

API documentation: attachOrganizationSaseSites

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[AttachOrganizationSaseSitesItemsItem] | None, default: None ) –

  List of Meraki SD-WAN sites with the associated regions to be attached.

• callback (AttachOrganizationSaseSitesCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Assign devices to a Cellular Data Management Profile in batch.

API documentation: batchOrganizationDevicesCellularDataProfilesAssignmentsCreate

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BatchOrganizationDevicesCellularDataProfilesAssignmentsCreateItemsItem]) –

  List of device-to-profile assignments to create.

Delete SSE Connectors by ID.

API documentation: batchOrganizationSaseConnectorsDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BatchOrganizationSaseConnectorsDeleteItemsItem] | None, default: None ) –

  List of connectors to delete (maximum 20 items).

Unassign devices from a Cellular Data Management Profile in batch.

API documentation: bulkOrganizationDevicesCellularDataProfilesAssignmentsDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BulkOrganizationDevicesCellularDataProfilesAssignmentsDeleteItemsItem]) –

  List of device-to-profile assignments to remove.

BulkDelete packet captures from cloud.

API documentation: bulkOrganizationDevicesPacketCaptureCapturesDelete

Parameters:

• organization_id (str) –

  Organization ID.

• capture_ids (list[str]) –

  Delete the packet captures of the specified capture ids.

Updating device details (currently only used for Catalyst devices).

API documentation: bulkUpdateOrganizationDevicesDetails

Parameters:

• organization_id (str) –

  Organization ID.

• serials (list[str]) –

  A list of serials of devices to update.

• details (list[BulkUpdateOrganizationDevicesDetailsDetailsItem]) –

  An array of details.

Claim an order by the secure unique order claim number, the order claim id.

API documentation: claimOrganizationInventoryOrders

Parameters:

• organization_id (str) –

  Organization ID.

• claim_id (str) –

  The unique order claim id.

• subscriptions (list[ClaimOrganizationInventoryOrdersSubscriptionsItem] | None, default: None ) –

  The individual subscriptions to claim.

Combine multiple networks into a single network.

API documentation: combineOrganizationNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the combined network.

• network_ids (list[str]) –

  A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network.

• enrollment_string (str | None, default: None ) –

  A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.

Creates new adaptive policy ACL.

API documentation: createOrganizationAdaptivePolicyAcl

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the adaptive policy ACL.

• description (str | None, default: None ) –

  Description of the adaptive policy ACL.

• rules (list[CreateOrganizationAdaptivePolicyAclRulesItem]) –

  An ordered array of the adaptive policy ACL rules.

• ip_version (CreateOrganizationAdaptivePolicyAclIpVersion) –

  IP version of adpative policy ACL. One of: 'any', 'ipv4' or 'ipv6'.

Creates a new adaptive policy group.

API documentation: createOrganizationAdaptivePolicyGroup

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the group.

• sgt (int) –

  SGT value of the group.

• description (str | None, default: None ) –

  Description of the group (default: "").

• policy_objects (list[CreateOrganizationAdaptivePolicyGroupPolicyObjectsItem] | None, default: None ) –

  The policy objects that belong to this group; traffic from addresses specified by these policy objects will be tagged with this group's SGT value if no other tagging scheme is being used (each requires one unique attribute) (default: []).

Add an Adaptive Policy.

API documentation: createOrganizationAdaptivePolicyPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• source_group (CreateOrganizationAdaptivePolicyPolicySourceGroup) –

  The source adaptive policy group (requires one unique attribute).

• destination_group (CreateOrganizationAdaptivePolicyPolicyDestinationGroup) –

  The destination adaptive policy group (requires one unique attribute).

• acls (list[CreateOrganizationAdaptivePolicyPolicyAclsItem] | None, default: None ) –

  An ordered array of adaptive policy ACLs (each requires one unique attribute) that apply to this policy (default: []).

• last_entry_rule (CreateOrganizationAdaptivePolicyPolicyLastEntryRule | None, default: None ) –

  The rule to apply if there is no matching ACL (default: "default").

Create an organization-wide alert configuration.

API documentation: createOrganizationAlertsProfile

Parameters:

• organization_id (str) –

  Organization ID.

• type_ (CreateOrganizationAlertsProfileType) –

  The alert type.

• alert_condition (CreateOrganizationAlertsProfileAlertCondition) –

  The conditions that determine if the alert triggers.

• recipients (CreateOrganizationAlertsProfileRecipients) –

  List of recipients that will recieve the alert.

• network_tags (list[str]) –

  Networks with these tags will be monitored for the alert.

• description (str | None, default: None ) –

  User supplied description of the alert.

Add a new branding policy to an organization.

API documentation: createOrganizationBrandingPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the Dashboard branding policy.

• enabled (bool | None, default: None ) –

  Boolean indicating whether this policy is enabled.

• admin_settings (CreateOrganizationBrandingPolicyAdminSettings | None, default: None ) –

  Settings for describing which kinds of admins this policy applies to.

• help_settings (CreateOrganizationBrandingPolicyHelpSettings | None, default: None ) –

  Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values. Each property defaults to 'default or inherit' when not provided.

• custom_logo (CreateOrganizationBrandingPolicyCustomLogo | None, default: None ) –

  Properties describing the custom logo attached to the branding policy.

Create a new configuration template.

API documentation: createOrganizationConfigTemplate

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the configuration template.

• time_zone (str | None, default: None ) –

  The timezone of the configuration template. For a list of allowed timezones, please see the 'TZ' column in the table in this article. Not applicable if copying from existing network or template.

• copy_from_network_id (str | None, default: None ) –

  The ID of the network or config template to copy configuration from.

Add a cellular data management profile to this organization.

API documentation: createOrganizationDevicesCellularDataProfile

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the profile to be added. This must be unique.

• description (str) –

  Description of the profile to be added.

• rules (list[CreateOrganizationDevicesCellularDataProfileRulesItem]) –

  The rules associated with this profile. At least one rule and no more than two rules may be defined for a profile.

Migrate devices to another controller or management mode.

API documentation: createOrganizationDevicesControllerMigration

Parameters:

• organization_id (str) –

  Organization ID.

• serials (list[str]) –

  A list of Meraki Serials to migrate.

• target (CreateOrganizationDevicesControllerMigrationTarget) –

  The controller or management mode to which the devices will be migrated.

Create a schedule for packet capture.

API documentation: createOrganizationDevicesPacketCaptureSchedule

Parameters:

• organization_id (str) –

  Organization ID.

• devices (list[CreateOrganizationDevicesPacketCaptureScheduleDevicesItem]) –

  device details.

• name (str | None, default: None ) –

  Name of the packet capture file.

• notes (str | None, default: None ) –

  Reason for capture.

• duration (int | None, default: None ) –

  Duration of the capture in seconds.

• filter_expression (str | None, default: None ) –

  Filter expression for the capture.

• enabled (bool | None, default: None ) –

  Enable or disable the schedule.

• schedule (CreateOrganizationDevicesPacketCaptureScheduleSchedule | None, default: None ) –

  Schedule details.

Create a network.

API documentation: createOrganizationNetwork

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the new network.

• product_types (CreateOrganizationNetworkProductTypes) –

  The product type(s) of the new network. If more than one type is included, the network will be a combined network.

• tags (list[str] | None, default: None ) –

  A list of tags to be applied to the network.

• time_zone (str | None, default: None ) –

  The timezone of the network. For a list of allowed timezones, please see the 'TZ' column in the table in this article..

• copy_from_network_id (str | None, default: None ) –

  The ID of the network to copy configuration from. Other provided parameters will override the copied configuration, except type which must match this network's type exactly.

• notes (str | None, default: None ) –

  Add any notes or additional information about this network here.

Create an Organization-Wide Policy Firewall Ruleset.

API documentation: createOrganizationPoliciesGlobalFirewallRuleset

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the firewall ruleset.

• description (str | None, default: None ) –

  Description of the firewall ruleset.

Create an Organization-Wide Policy Firewall Rule.

API documentation: createOrganizationPoliciesGlobalFirewallRulesetsRule

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the firewall rule.

• ruleset_id (str) –

  Firewall ruleset ID to associate the rule with.

• policy (CreateOrganizationPoliciesGlobalFirewallRulesetsRulePolicy) –

  Rule policy - allow or deny traffic.

• enabled (bool | None, default: None ) –

  Whether the rule is enabled.

• priority (int | None, default: None ) –

  Rule priority (lower numbers = higher priority).

• description (str | None, default: None ) –

  Description of the firewall rule.

• sources (CreateOrganizationPoliciesGlobalFirewallRulesetsRuleSources) –

  Source traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

• destinations (CreateOrganizationPoliciesGlobalFirewallRulesetsRuleDestinations) –

  Destination traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

Create an Organization-Wide Policy Ruleset Assignment.

API documentation: createOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

Parameters:

• organization_id (str) –

  Organization ID.

• ruleset_id (str) –

  ID of the ruleset to assign.

• policy_id (str) –

  ID of the policy to assign the ruleset to.

• priority (int | None, default: None ) –

  Priority of the ruleset assignment (lower numbers = higher priority).

Create an Organization-Wide Policy.

API documentation: createOrganizationPoliciesGlobalGroupPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the policy.

• description (str | None, default: None ) –

  Description of the policy.

Creates a new Policy Object.

API documentation: createOrganizationPolicyObject

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• category (str) –

  Category of a policy object (one of: adaptivePolicy, network).

• type_ (str) –

  Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask).

• cidr (str | None, default: None ) –

  CIDR Value of a policy object (e.g. 10.11.12.1/24").

• fqdn (str | None, default: None ) –

  Fully qualified domain name of policy object (e.g. "example.com").

• mask (str | None, default: None ) –

  Mask of a policy object (e.g. "255.255.0.0").

• ip (str | None, default: None ) –

  IP Address of a policy object (e.g. "1.2.3.4").

• group_ids (list[str] | None, default: None ) –

  The IDs of policy object groups the policy object belongs to.

Creates a new Policy Object Group.

API documentation: createOrganizationPolicyObjectsGroup

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  A name for the group of network addresses, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• category (str | None, default: None ) –

  Category of a policy object group (one of: NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup).

• object_ids (list[str] | None, default: None ) –

  A list of Policy Object ID's that this NetworkObjectGroup should be associated to (note: these ID's will replace the existing associated Policy Objects).

Create a SAML IdP for your organization.

API documentation: createOrganizationSamlIdp

Parameters:

• organization_id (str) –

  Organization ID.

• x509cert_sha1_fingerprint (str) –

  Fingerprint (SHA1) of the SAML certificate provided by your Identity Provider (IdP). This will be used for encryption / validation.

• sso_login_url (str | None, default: None ) –

  Dashboard will redirect users to this URL to log in again when their sessions expire.

• slo_logout_url (str | None, default: None ) –

  Dashboard will redirect users to this URL when they sign out.

Create a new Secure Access integration.

API documentation: createOrganizationSaseIntegration

Parameters:

• organization_id (str) –

  Organization ID.

• api (CreateOrganizationSaseIntegrationApi) –

  API credentials.

Create a Splash Theme.

API documentation: createOrganizationSplashTheme

Parameters:

• organization_id (str) –

  Organization ID.

• name (str | None, default: None ) –

  theme name.

• base_theme (str | None, default: None ) –

  base theme id.

Create a Splash Theme Asset.

API documentation: createOrganizationSplashThemeAsset

Parameters:

• organization_id (str) –

  Organization ID.

• theme_identifier (str) –

  Theme identifier.

• name (str | None, default: None ) –

  File name. Will overwrite files with same name.

• content (str | None, default: None ) –

  a file containing the asset content.

Deletes the specified adaptive policy ACL.

API documentation: deleteOrganizationAdaptivePolicyAcl

Parameters:

• organization_id (str) –

  Organization ID.

• acl_id (str) –

  Acl ID.

Deletes the specified adaptive policy group and any associated policies and references.

API documentation: deleteOrganizationAdaptivePolicyGroup

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Delete an Adaptive Policy.

API documentation: deleteOrganizationAdaptivePolicyPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Removes an organization-wide alert config.

API documentation: deleteOrganizationAlertsProfile

Parameters:

• organization_id (str) –

  Organization ID.

• alert_config_id (str) –

  Alert config ID.

Delete a branding policy.

API documentation: deleteOrganizationBrandingPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• branding_policy_id (str) –

  Branding policy ID.

Delete a cellular data management profile from this organization.

API documentation: deleteOrganizationDevicesCellularDataProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Delete a single packet capture from cloud using captureId.

API documentation: deleteOrganizationDevicesPacketCaptureCapture

Parameters:

• organization_id (str) –

  Organization ID.

• capture_id (str) –

  Capture ID.

Delete schedule from cloud.

API documentation: deleteOrganizationDevicesPacketCaptureSchedule

Parameters:

• organization_id (str) –

  Organization ID.

• schedule_id (str) –

  Schedule ID.

Delete an Organization-Wide Policy Firewall Ruleset.

API documentation: deleteOrganizationPoliciesGlobalFirewallRuleset

Parameters:

• organization_id (str) –

  Organization ID.

• ruleset_id (str) –

  Ruleset ID.

Delete an Organization-Wide Policy Firewall Rule.

API documentation: deleteOrganizationPoliciesGlobalFirewallRulesetsRule

Parameters:

• organization_id (str) –

  Organization ID.

• rule_id (str) –

  Rule ID.

Delete an Organization-Wide Policy Ruleset Assignment.

API documentation: deleteOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

Parameters:

• organization_id (str) –

  Organization ID.

• assignment_id (str) –

  Assignment ID.

Delete an Organization-Wide Policy.

API documentation: deleteOrganizationPoliciesGlobalGroupPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• policy_id (str) –

  Policy ID.

Deletes a Policy Object.

API documentation: deleteOrganizationPolicyObject

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_id (str) –

  Policy object ID.

Deletes a Policy Object Group.

API documentation: deleteOrganizationPolicyObjectsGroup

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_group_id (str) –

  Policy object group ID.

Remove a SAML IdP in your organization.

API documentation: deleteOrganizationSamlIdp

Parameters:

• organization_id (str) –

  Organization ID.

• idp_id (str) –

  Idp ID.

Remove a Secure Access integration.

API documentation: deleteOrganizationSaseIntegration

Parameters:

• organization_id (str) –

  Organization ID.

• integration_id (str) –

  Integration ID.

Delete a Splash Theme Asset.

API documentation: deleteOrganizationSplashAsset

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Delete a Splash Theme.

API documentation: deleteOrganizationSplashTheme

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Detach sites in this organization from Secure Access.

API documentation: detachOrganizationSaseSites

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[DetachOrganizationSaseSitesItemsItem] | None, default: None ) –

  List of Secure Access sites to be detached.

• callback (DetachOrganizationSaseSitesCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Disable XDR on networks.

API documentation: disableOrganizationIntegrationsXdrNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• networks (list[DisableOrganizationIntegrationsXdrNetworksNetworksItem]) –

  List containing the network ID and the product type to disable XDR on.

Enable XDR on networks.

API documentation: enableOrganizationIntegrationsXdrNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• networks (list[EnableOrganizationIntegrationsXdrNetworksNetworksItem]) –

  List containing the network ID and the product type to enable XDR on.

Move licenses to another organization.

API documentation: moveOrganizationLicenses

Parameters:

• organization_id (str) –

  Organization ID.

• dest_organization_id (str) –

  The ID of the organization to move the licenses to.

• license_ids (list[str]) –

  A list of IDs of licenses to move to the new organization.

Move SM seats to another organization.

API documentation: moveOrganizationLicensesSeats

Parameters:

• organization_id (str) –

  Organization ID.

• dest_organization_id (str) –

  The ID of the organization to move the SM seats to.

• license_id (str) –

  The ID of the SM license to move the seats from.

• seat_count (int) –

  The number of seats to move to the new organization. Must be less than or equal to the total number of seats of the license.

Remove adaptive policy groups from a policy.

API documentation: removeOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroups

Parameters:

• organization_id (str) –

  Organization ID.

• policy (RemoveOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsPolicy) –

  Policy to remove adaptive policy groups from.

• adaptive_policy_groups (list[RemoveOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsAdaptivePolicyGroupsItem]) –

  Adaptive policy groups to remove.

Renew SM seats of a license.

API documentation: renewOrganizationLicensesSeats

Parameters:

• organization_id (str) –

  Organization ID.

• license_id_to_renew (str) –

  The ID of the SM license to renew. This license must already be assigned to an SM network.

• unused_license_id (str) –

  The SM license to use to renew the seats on 'licenseIdToRenew'. This license must have at least as many seats available as there are seats on 'licenseIdToRenew'.

Bulk update priorities of pcap schedules.

API documentation: reorderOrganizationDevicesPacketCaptureSchedules

Parameters:

• organization_id (str) –

  Organization ID.

• order (list[ReorderOrganizationDevicesPacketCaptureSchedulesOrderItem]) –

  Array of schedule IDs and their priorities to reorder.

Updates an adaptive policy ACL.

API documentation: updateOrganizationAdaptivePolicyAcl

Parameters:

• organization_id (str) –

  Organization ID.

• acl_id (str) –

  Acl ID.

• name (str | None, default: None ) –

  Name of the adaptive policy ACL.

• description (str | None, default: None ) –

  Description of the adaptive policy ACL.

• rules (list[UpdateOrganizationAdaptivePolicyAclRulesItem] | None, default: None ) –

  An ordered array of the adaptive policy ACL rules. An empty array will clear the rules.

• ip_version (UpdateOrganizationAdaptivePolicyAclIpVersion | None, default: None ) –

  IP version of adpative policy ACL. One of: 'any', 'ipv4' or 'ipv6'.

Updates an adaptive policy group.

API documentation: updateOrganizationAdaptivePolicyGroup

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

• name (str | None, default: None ) –

  Name of the group.

• sgt (int | None, default: None ) –

  SGT value of the group.

• description (str | None, default: None ) –

  Description of the group.

• policy_objects (list[UpdateOrganizationAdaptivePolicyGroupPolicyObjectsItem] | None, default: None ) –

  The policy objects that belong to this group; traffic from addresses specified by these policy objects will be tagged with this group's SGT value if no other tagging scheme is being used (each requires one unique attribute).

Update an Adaptive Policy.

API documentation: updateOrganizationAdaptivePolicyPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

• source_group (UpdateOrganizationAdaptivePolicyPolicySourceGroup | None, default: None ) –

  The source adaptive policy group (requires one unique attribute).

• destination_group (UpdateOrganizationAdaptivePolicyPolicyDestinationGroup | None, default: None ) –

  The destination adaptive policy group (requires one unique attribute).

• acls (list[UpdateOrganizationAdaptivePolicyPolicyAclsItem] | None, default: None ) –

  An ordered array of adaptive policy ACLs (each requires one unique attribute) that apply to this policy.

• last_entry_rule (UpdateOrganizationAdaptivePolicyPolicyLastEntryRule | None, default: None ) –

  The rule to apply if there is no matching ACL.

Update global adaptive policy settings.

API documentation: updateOrganizationAdaptivePolicySettings

Parameters:

• organization_id (str) –

  Organization ID.

• enabled_networks (list[str] | None, default: None ) –

  List of network IDs with adaptive policy enabled.

Update an organization-wide alert config.

API documentation: updateOrganizationAlertsProfile

Parameters:

• organization_id (str) –

  Organization ID.

• alert_config_id (str) –

  Alert config ID.

• enabled (bool | None, default: None ) –

  Is the alert config enabled.

• type_ (UpdateOrganizationAlertsProfileType | None, default: None ) –

  The alert type.

• alert_condition (UpdateOrganizationAlertsProfileAlertCondition | None, default: None ) –

  The conditions that determine if the alert triggers.

• recipients (UpdateOrganizationAlertsProfileRecipients | None, default: None ) –

  List of recipients that will recieve the alert.

• network_tags (list[str] | None, default: None ) –

  Networks with these tags will be monitored for the alert.

• description (str | None, default: None ) –

  User supplied description of the alert.

Update the priority ordering of an organization's branding policies.

API documentation: updateOrganizationBrandingPoliciesPriorities

Parameters:

• organization_id (str) –

  Organization ID.

• branding_policy_ids (list[str] | None, default: None ) –

  An ordered list of branding policy IDs that determines the priority order of how to apply the policies.

Update a branding policy.

API documentation: updateOrganizationBrandingPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• branding_policy_id (str) –

  Branding policy ID.

• name (str) –

  Name of the Dashboard branding policy.

• enabled (bool | None, default: None ) –

  Boolean indicating whether this policy is enabled.

• admin_settings (UpdateOrganizationBrandingPolicyAdminSettings | None, default: None ) –

  Settings for describing which kinds of admins this policy applies to.

• help_settings (UpdateOrganizationBrandingPolicyHelpSettings | None, default: None ) –

  Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values.

• custom_logo (UpdateOrganizationBrandingPolicyCustomLogo | None, default: None ) –

  Properties describing the custom logo attached to the branding policy.

Update a configuration template.

API documentation: updateOrganizationConfigTemplate

Parameters:

• organization_id (str) –

  Organization ID.

• config_template_id (str) –

  Config template ID.

• name (str | None, default: None ) –

  The name of the configuration template.

• time_zone (str | None, default: None ) –

  The timezone of the configuration template. For a list of allowed timezones, please see the 'TZ' column in the table in this article..

Update a Cellular Data Management Profile.

API documentation: updateOrganizationDevicesCellularDataProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

• description (str | None, default: None ) –

  New description of the profile.

• rules (list[UpdateOrganizationDevicesCellularDataProfileRulesItem]) –

  The rules associated with this profile. At least one rule and no more than two rules may be defined for a profile.

Update a schedule for packet capture.

API documentation: updateOrganizationDevicesPacketCaptureSchedule

Parameters:

• organization_id (str) –

  Organization ID.

• schedule_id (str) –

  Schedule ID.

• devices (list[UpdateOrganizationDevicesPacketCaptureScheduleDevicesItem]) –

  device details.

• name (str | None, default: None ) –

  Name of the packet capture file.

• notes (str | None, default: None ) –

  Reason for capture.

• duration (int | None, default: None ) –

  Duration of the capture in seconds.

• filter_expression (str | None, default: None ) –

  Filter expression for the capture.

• enabled (bool | None, default: None ) –

  Enable or disable the schedule.

• schedule (UpdateOrganizationDevicesPacketCaptureScheduleSchedule | None, default: None ) –

  Schedule details.

Update an early access feature opt-in for an organization.

API documentation: updateOrganizationEarlyAccessFeaturesOptIn

Parameters:

• organization_id (str) –

  Organization ID.

• opt_in_id (str) –

  Opt in ID.

• limit_scope_to_networks (list[str] | None, default: None ) –

  A list of network IDs to apply the opt-in to.

Update a license.

API documentation: updateOrganizationLicense

Parameters:

• organization_id (str) –

  Organization ID.

• license_id (str) –

  License ID.

• device_serial (str | None, default: None ) –

  The serial number of the device to assign this license to. Set this to null to unassign the license. If a different license is already active on the device, this parameter will control queueing/dequeuing this license.

Update the login security settings for an organization.

API documentation: updateOrganizationLoginSecurity

Parameters:

• organization_id (str) –

  Organization ID.

• enforce_password_expiration (bool | None, default: None ) –

  Boolean indicating whether users are forced to change their password every X number of days.

• password_expiration_days (int | None, default: None ) –

  Number of days after which users will be forced to change their password.

• enforce_different_passwords (bool | None, default: None ) –

  Boolean indicating whether users, when setting a new password, are forced to choose a new password that is different from any past passwords.

• num_different_passwords (int | None, default: None ) –

  Number of recent passwords that new password must be distinct from.

• enforce_strong_passwords (bool | None, default: None ) –

  Deprecated. Values of 'false' are always ignored.

• minimum_password_length (int | None, default: None ) –

  Minimum number of characters required in admins' passwords.

• enforce_account_lockout (bool | None, default: None ) –

  Boolean indicating whether users' Dashboard accounts will be locked out after a specified number of consecutive failed login attempts.

• account_lockout_attempts (int | None, default: None ) –

  Number of consecutive failed login attempts after which users' accounts will be locked.

• enforce_idle_timeout (bool | None, default: None ) –

  Boolean indicating whether users will be logged out after being idle for the specified number of minutes.

• idle_timeout_minutes (int | None, default: None ) –

  Number of minutes users can remain idle before being logged out of their accounts.

• enforce_two_factor_auth (bool | None, default: None ) –

  Boolean indicating whether users in this organization will be required to use an extra verification code when logging in to Dashboard. This code will be sent to their mobile phone via SMS, or can be generated by the authenticator application.

• enforce_login_ip_ranges (bool | None, default: None ) –

  Boolean indicating whether organization will restrict access to Dashboard (including the API) from certain IP addresses.

• login_ip_ranges (list[str] | None, default: None ) –

  List of acceptable IP ranges. Entries can be single IP addresses, IP address ranges, and CIDR subnets.

• api_authentication (UpdateOrganizationLoginSecurityApiAuthentication | None, default: None ) –

  Details for indicating whether organization will restrict access to API (but not Dashboard) to certain IP addresses.

Update an Organization-Wide Policy Firewall Ruleset.

API documentation: updateOrganizationPoliciesGlobalFirewallRuleset

Parameters:

• organization_id (str) –

  Organization ID.

• ruleset_id (str) –

  Ruleset ID.

• name (str | None, default: None ) –

  Name of the firewall ruleset.

• description (str | None, default: None ) –

  Description of the firewall ruleset.

Update an Organization-Wide Policy Firewall Rule.

API documentation: updateOrganizationPoliciesGlobalFirewallRulesetsRule

Parameters:

• organization_id (str) –

  Organization ID.

• rule_id (str) –

  Rule ID.

• name (str | None, default: None ) –

  Name of the firewall rule.

• ruleset_id (str | None, default: None ) –

  Firewall ruleset ID to associate the rule with.

• policy (UpdateOrganizationPoliciesGlobalFirewallRulesetsRulePolicy | None, default: None ) –

  Rule policy - allow or deny traffic.

• enabled (bool | None, default: None ) –

  Whether the rule is enabled.

• priority (int | None, default: None ) –

  Rule priority (lower numbers = higher priority).

• description (str | None, default: None ) –

  Description of the firewall rule.

• sources (UpdateOrganizationPoliciesGlobalFirewallRulesetsRuleSources | None, default: None ) –

  Source traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

• destinations (UpdateOrganizationPoliciesGlobalFirewallRulesetsRuleDestinations | None, default: None ) –

  Destination traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

Update an Organization-Wide Policy Ruleset Assignment.

API documentation: updateOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

Parameters:

• organization_id (str) –

  Organization ID.

• assignment_id (str) –

  Assignment ID.

• ruleset_id (str | None, default: None ) –

  ID of the ruleset to assign.

• policy_id (str | None, default: None ) –

  ID of the policy to assign the ruleset to.

• priority (int | None, default: None ) –

  Priority of the ruleset assignment (lower numbers = higher priority).

Update an Organization-Wide Policy.

API documentation: updateOrganizationPoliciesGlobalGroupPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• policy_id (str) –

  Policy ID.

• name (str | None, default: None ) –

  Name of the policy.

• description (str | None, default: None ) –

  Description of the policy.

Updates a Policy Object.

API documentation: updateOrganizationPolicyObject

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_id (str) –

  Policy object ID.

• name (str | None, default: None ) –

  Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• cidr (str | None, default: None ) –

  CIDR Value of a policy object (e.g. 10.11.12.1/24").

• fqdn (str | None, default: None ) –

  Fully qualified domain name of policy object (e.g. "example.com").

• mask (str | None, default: None ) –

  Mask of a policy object (e.g. "255.255.0.0").

• ip (str | None, default: None ) –

  IP Address of a policy object (e.g. "1.2.3.4").

• group_ids (list[str] | None, default: None ) –

  The IDs of policy object groups the policy object belongs to.

Updates a Policy Object Group.

API documentation: updateOrganizationPolicyObjectsGroup

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_group_id (str) –

  Policy object group ID.

• name (str | None, default: None ) –

  A name for the group of network addresses, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• object_ids (list[str] | None, default: None ) –

  A list of Policy Object ID's that this NetworkObjectGroup should be associated to (note: these ID's will replace the existing associated Policy Objects).

Update a SAML IdP in your organization.

API documentation: updateOrganizationSamlIdp

Parameters:

• organization_id (str) –

  Organization ID.

• idp_id (str) –

  Idp ID.

• x509cert_sha1_fingerprint (str | None, default: None ) –

  Fingerprint (SHA1) of the SAML certificate provided by your Identity Provider (IdP). This will be used for encryption / validation.

• sso_login_url (str | None, default: None ) –

  Dashboard will redirect users to this URL to log in again when their sessions expire.

• slo_logout_url (str | None, default: None ) –

  Dashboard will redirect users to this URL when they sign out.

Update the configuration for a site.

API documentation: updateOrganizationSaseSite

Parameters:

• organization_id (str) –

  Organization ID.

• site_id (str) –

  Site ID.

• routing (UpdateOrganizationSaseSiteRouting | None, default: None ) –

  Routing configuration for the site.