cbi_profile¶

The following methods allow for interaction with the ZPA Cloud Browser Isolation Profile API endpoints.

Methods are accessible via zpa.cbi_profile

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class CBIProfileAPI¶

Bases: APIClient

A Client object for the Cloud Browser Isolation Profile resource.

add_cbi_profile(**kwargs)¶

Adds a new cloud browser isolation profile to the Zscaler platform.

Parameters:

name (str) – The name of the new cloud browser isolation profile.
region_ids (list) – List of region IDs. Requires at least 2 region IDs.
certificate_ids (list) – List of certificate IDs associated with the profile.

Keyword Arguments:

description (str, optional) – A brief description of the security profile.
is_default (bool, optional) – Indicates if this profile should be set as the default for new users.
banner_id (str, optional) – The unique identifier for a custom banner displayed in the isolation session.
security_controls (dict, optional) –
Specifies the cloud browser isolation security settings.
- document_viewer (bool): Enable or disable document viewing capabilities
- allow_printing (bool): Allow or restrict printing of documents
- watermark (dict): Configuration for watermarking documents displayed in the browser:
  - enabled (bool): Enable or disable watermarking
  - show_user_id (bool): Display user ID on the watermark.
  - show_timestamp (bool): Include a timestamp in the watermark.
  - show_message (bool): Include a custom message in the watermark.
  - message (str): The custom message to display if ‘show_message’ is True.
- flattened_pdf (bool): Specify whether PDFs should be flattened.
- upload_download (str): Control upload and download capabilities (‘all’, ‘none’, or other configurations).
- restrict_keystrokes (bool): Restrict the use of keystrokes within the isolation session.
- copy_paste (str): Control copy and paste capabilities (‘all’, ‘none’, or specific configurations).
- local_render (bool): Enable or disable local rendering of web content.
debug_mode (dict, optional) –
Debug mode settings that may include logging and error tracking configurations.
- allowed (bool, optional): Allow debug mode
- file_password (str, Optional): Optional password to debug files when this mode is enabled.
user_experience (dict, optional) –
Settings that affect how end-users interact with the isolated browser.
- forward_to_zia (dict): Configuration for forwarding traffic to ZIA:
  - enabled (bool): Enable or disable forwarding.
  - organization_id (str): Organization ID to use for forwarding.
  - cloud_name (str): Name of the Zscaler cloud.
  - pac_file_url (str): URL to the PAC file.
- browser_in_browser (bool): Enable or disable the use of a browser within the isolated browser.
- persist_isolation_bar (bool): Specify whether the isolation bar should remain visible.
- session_persistence (bool): Enable or disable session persistence across browser restarts.

Returns:

A tuple containing the CBIProfile instance, response object, and error if any.

Return type:

Tuple

Examples

Creating a security profile with required and optional parameters:

>>> added_profile, _, err = zpa.cbi_profile.add_cbi_profile(
...   name='Add_CBI_Profile',
...   region_ids=["dc75dc8d-a713-49aa-821e-eb35da523cc2", "1a2cd1bc-b8e0-466b-96ad-fbe44832e1c7"],
...   certificate_ids=["87122222-457f-11ed-b878-0242ac120002"],
...   description='Description of Add_CBI_Profile',
...   security_controls={
...       "document_viewer": True,
...       "allow_printing": True,
...       "watermark": {
...           "enabled": True,
...           "show_user_id": True,
...           "show_timestamp": True,
...           "show_message": True,
...           "message": "Confidential"
...       },
...       "flattened_pdf": False,
...       "upload_download": "all",
...       "restrict_keystrokes": True,
...       "copy_paste": "all",
...       "local_render": True
...   },
...   debug_mode={
...       "allowed": True,
...       "file_password": ""
...   },
...   user_experience={
...       "forward_to_zia": {
...           "enabled": True,
...           "organization_id": "44772833",
...           "cloud_name": "example_cloud",
...           "pac_file_url": "https://pac.example_cloud/proxy.pac"
...       },
...       "browser_in_browser": True,
...       "persist_isolation_bar": True,
...       "session_persistence": True
...   },
...   banner_id="97f339f6-9f85-40fb-8b76-f62cdf8f795c"
... )
... if err:
...     print(f"Error adding cbi profile: {err}")
...     return
... print(f"CBI profile added successfully: {added_profile.as_dict()}")

delete_cbi_profile(profile_id)¶

Deletes the specified cloud browser isolation profile.

Parameters:: profile_id (str) – The unique identifier of the cloud browser isolation profile.
Returns:: A tuple containing the response object and error if any.
Return type:: Tuple

Examples

>>> _, _, err = client.zpa.cbi_profile.delete_cbi_profile(
...     profile_id='ab73fa29-667a-4057-83c5-6a8dccf84930'
... )
... if err:
...     print(f"Error deleting cbi profile: {err}")
...     return
... print(f"CBI Profile with ID {ab73fa29-667a-4057-83c5-6a8dccf84930} deleted successfully.")

get_cbi_profile(profile_id)¶

Returns information on the specified cloud browser isolation profile.

Parameters:: profile_id (str) – The unique identifier for the cloud browser isolation profile.
Returns:: A tuple containing the CBIProfile instance, response object, and error if any.
Return type:: Tuple

Examples

>>> fetched_profile, _, err = client.zpa.cbi_profile.get_cbi_profile(
... profile_id='ab73fa29-667a-4057-83c5-6a8dccf84930')
... if err:
...     print(f"Error fetching profile by ID: {err}")
...     return
... print(f"Fetched profile by ID: {fetched_profile.as_dict()}")

list_cbi_profiles()¶

Returns a list of all cloud browser isolation profile.

Parameters:: scope_id (str, optional) – The unique identifier of the scope of the tenant to filter the profiles.
Returns:: A tuple containing a list of CBIProfile instances, response object, and error if any.
Return type:: Tuple

Examples

>>> profile_list, _, err = client.zpa.cbi_profile.list_cbi_profiles()
... if err:
...     print(f"Error listing profiles: {err}")
...     return
... print(f"Total profiles found: {len(profile_list)}")
... for profile in profile_list:
...     print(profile.as_dict())

update_cbi_profile(profile_id, **kwargs)¶

Updates an existing cloud browser isolation profile.

Parameters:

profile_id (str) – The unique identifier for the cloud browser isolation profile to be updated.
**kwargs – Optional keyword args.

Keyword Arguments:

description (str, optional) – A brief description of the security profile.
is_default (bool, optional) – Indicates if this profile should be set as the default for new users.
banner_id (str, optional) – The unique identifier for a custom banner displayed in the isolation session.
security_controls (dict, optional) –
Specifies the cloud browser isolation security settings.
- document_viewer (bool): Enable or disable document viewing capabilities
- allow_printing (bool): Allow or restrict printing of documents
- watermark (dict): Configuration for watermarking documents displayed in the browser:
  - enabled (bool): Enable or disable watermarking
  - show_user_id (bool): Display user ID on the watermark.
  - show_timestamp (bool): Include a timestamp in the watermark.
  - show_message (bool): Include a custom message in the watermark.
  - message (str): The custom message to display if ‘show_message’ is True.
- flattened_pdf (bool): Specify whether PDFs should be flattened.
- upload_download (str): Control upload and download capabilities (‘all’, ‘none’, or other configurations).
- restrict_keystrokes (bool): Restrict the use of keystrokes within the isolation session.
- copy_paste (str): Control copy and paste capabilities (‘all’, ‘none’, or specific configurations).
- local_render (bool): Enable or disable local rendering of web content.
debug_mode (dict, optional) –
Debug mode settings that may include logging and error tracking configurations.
- allowed (bool, optional): Allow debug mode
- file_password (str, Optional): Optional password to debug files when this mode is enabled.
user_experience (dict, optional) –
Settings that affect how end-users interact with the isolated browser.
- forward_to_zia (dict): Configuration for forwarding traffic to ZIA:
  - enabled (bool): Enable or disable forwarding.
  - organization_id (str): Organization ID to use for forwarding.
  - cloud_name (str): Name of the Zscaler cloud.
  - pac_file_url (str): URL to the PAC file.
- browser_in_browser (bool): Enable or disable the use of a browser within the isolated browser.
- persist_isolation_bar (bool): Specify whether the isolation bar should remain visible.
- session_persistence (bool): Enable or disable session persistence across browser restarts.

Returns:

A tuple containing the CBIProfile instance, response object, and error if any.

Return type:

Tuple

Examples

Updating the name and description of a cloud browser isolation profile:

>>> updated_profile, _, err = zpa.cbi_profile.update_cbi_profile(
...   profile_id='1beed6be-eb22-4328-92f2-fbe73fd6e5c7',
...   name='CBI_Profile_Update'
...   description='CBI_Profile_Update'
)
... if err:
...     print(f"Error adding cbi profile: {err}")
...     return
... print(f"CBI profile added successfully: {updated_profile.as_dict()}")