nextmv 1.0.0.dev10__py3-none-any.whl → 1.1.0.dev0__py3-none-any.whl

nextmv/__about__.py

@@ -1 +1 @@
-__version__ = "v1.0.0.dev10"
+__version__ = "v1.1.0.dev0"

nextmv/cli/cloud/__init__.py

@@ -17,6 +17,7 @@ from nextmv.cli.cloud.run import app as run_app
 from nextmv.cli.cloud.scenario import app as scenario_app
 from nextmv.cli.cloud.secrets import app as secrets_app
 from nextmv.cli.cloud.shadow import app as shadow_app
+from nextmv.cli.cloud.sso import app as sso_app
 from nextmv.cli.cloud.switchback import app as switchback_app
 from nextmv.cli.cloud.upload import app as upload_app
 from nextmv.cli.cloud.version import app as version_app
@@ -36,6 +37,7 @@ app.add_typer(run_app, name="run")
 app.add_typer(scenario_app, name="scenario")
 app.add_typer(secrets_app, name="secrets")
 app.add_typer(shadow_app, name="shadow")
+app.add_typer(sso_app, name="sso")
 app.add_typer(switchback_app, name="switchback")
 app.add_typer(upload_app, name="upload")
 app.add_typer(version_app, name="version")

nextmv/cli/cloud/account/__init__.py

@@ -20,9 +20,11 @@ app.add_typer(update_app)
 @app.callback()
 def callback() -> None:
     """
-    Manage SSO for your Nextmv Cloud account (organization).
+    Manage your Nextmv Cloud account (organization).
 
-    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link]
-    for assistance configuring SSO for your organization.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv
+    support[/bold][/link] for assistance configuring SSO for your organization.
+    You may use the [code]nextmv cloud sso[/code] command tree to manage the
+    SSO configuration for your organization.
     """
     pass

nextmv/cli/cloud/account/create.py

@@ -42,7 +42,10 @@ def create(
     Create a new Nextmv Cloud account in your organization.
 
     To create managed accounts, SSO must be configured for your organization.
-    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv
+    support[/bold][/link] for assistance. You may use the [code]nextmv cloud
+    sso[/code] command tree to manage the SSO configuration for your
+    organization.
 
     At least one administrator email address must be provided. Multiple
     administrators can be specified by repeating the --admins flag or by

nextmv/cli/cloud/sso/__init__.py

@@ -0,0 +1,32 @@
+"""
+This module defines the cloud sso command tree for the Nextmv CLI.
+"""
+
+import typer
+
+from nextmv.cli.cloud.sso.create import app as create_app
+from nextmv.cli.cloud.sso.delete import app as delete_app
+from nextmv.cli.cloud.sso.disable import app as disable_app
+from nextmv.cli.cloud.sso.enable import app as enable_app
+from nextmv.cli.cloud.sso.get import app as get_app
+from nextmv.cli.cloud.sso.update import app as update_app
+
+# Set up subcommand application.
+app = typer.Typer()
+app.add_typer(create_app)
+app.add_typer(delete_app)
+app.add_typer(disable_app)
+app.add_typer(enable_app)
+app.add_typer(get_app)
+app.add_typer(update_app)
+
+
+@app.callback()
+def callback() -> None:
+    """
+    Manage SSO for your Nextmv Cloud organization (account).
+
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link]
+    for assistance configuring SSO for your organization.
+    """
+    pass

nextmv/cli/cloud/sso/create.py

@@ -0,0 +1,97 @@
+"""
+This module defines the cloud sso create command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.sso import SSOConfiguration
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def create(
+    allow_non_domain_users: Annotated[
+        bool,
+        typer.Option(
+            "--allow-non-domain-users",
+            "-a",
+            help="Allow users who are not part of the SSO domain to access the Nextmv Cloud organization (account).",
+        ),
+    ] = False,
+    enabled: Annotated[
+        bool,
+        typer.Option(
+            "--enabled",
+            "-e",
+            help="Enable SSO for the Nextmv Cloud organization (account) at the time of creation. "
+            "Run [code]nextmv cloud sso enable[/code] to enable SSO after creation.",
+        ),
+    ] = False,
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Create a new SSO configuration for your Nextmv Cloud organization.
+
+    SSO must be configured to enable managed accounts in your organization.
+    Please contact [link=https://www.nextmv.io/contact][bold]Nextmv support[/bold][/link] for assistance.
+
+    You must provide either a metadata URL or a metadata document. The metadata
+    document contains the SAML configuration details from your identity provider.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Create an SSO configuration using a metadata URL.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.carrotexpress.com/saml/metadata"[/dim]
+
+    - Create and enable SSO configuration immediately.
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.bunnylogistics.io/metadata" \\
+            --enabled[/dim]
+
+    - Create SSO configuration allowing non-domain users.
+        $ [dim]nextmv cloud sso create --metadata-url "https://idp.hopmail.com/saml/metadata" \\
+            --allow-non-domain-users[/dim]
+
+    - Create SSO configuration using a metadata document string.
+        $ [dim]nextmv cloud sso create --metadata-document "<EntityDescriptor ...</EntityDescriptor>"[/dim]
+
+    - Create SSO configuration using the profile named [magenta]hare[/magenta].
+        $ [dim]nextmv cloud sso create --metadata-url "https://sso.cottontailcouriers.net/metadata" \\
+            --profile hare[/dim]
+    """
+
+    cloud_client = build_client(profile)
+    in_progress(msg="Creating configuration...")
+
+    configuration = SSOConfiguration.new(
+        client=cloud_client,
+        allow_non_domain_users=allow_non_domain_users,
+        enabled=enabled,
+        metadata_url=metadata_url,
+        metadata_document=metadata_document,
+    )
+    print_json(configuration.to_dict())

nextmv/cli/cloud/sso/delete.py

@@ -0,0 +1,58 @@
+"""
+This module defines the cloud sso delete command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def delete(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to deletion confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Deletes the SSO configuration.
+
+    You must have the [magenta]administrator[/magenta] role on the organization in order to delete it.
+
+    This action is permanent and cannot be undone. Use the --yes
+    flag to skip the confirmation prompt.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Delete the SSO configuration.
+        $ [dim]nextmv cloud sso delete[/dim]
+
+    - Delete the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso delete --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to delete the sso configuration? This action cannot be undone.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be deleted.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.delete()
+    success("SSO configuration has been deleted.")

nextmv/cli/cloud/sso/disable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso disable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def disable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to disable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Disables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso enable[/code] command to re-enable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Disable the SSO configuration.
+        $ [dim]nextmv cloud sso disable[/dim]
+
+    - Disable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso disable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to disable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be disabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.disable()
+    success("SSO configuration has been disabled.")

nextmv/cli/cloud/sso/enable.py

@@ -0,0 +1,56 @@
+"""
+This module defines the cloud sso enable command for the Nextmv CLI.
+"""
+
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.confirm import get_confirmation
+from nextmv.cli.message import info, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def enable(
+    yes: Annotated[
+        bool,
+        typer.Option(
+            "--yes",
+            "-y",
+            help="Agree to enable confirmation prompt. Useful for non-interactive sessions.",
+        ),
+    ] = False,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Enables the SSO configuration.
+
+    Use the --yes flag to skip the confirmation prompt. Use the [code]nextmv
+    cloud sso disable[/code] command to disable SSO.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Enable the SSO configuration.
+        $ [dim]nextmv cloud sso enable[/dim]
+
+    - Enable the SSO configuration without confirmation prompt.
+        $ [dim]nextmv cloud sso enable --yes[/dim]
+    """
+
+    if not yes:
+        confirm = get_confirmation(
+            "Are you sure you want to enable the sso configuration?.",
+        )
+
+        if not confirm:
+            info("SSO configuration will not be enabled.")
+            return
+
+    sso_config = build_sso_config(profile)
+    sso_config.enable()
+    success("SSO configuration has been enabled.")

nextmv/cli/cloud/sso/get.py

@@ -0,0 +1,61 @@
+"""
+This module defines the cloud sso get command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_client
+from nextmv.cli.message import in_progress, print_json, success
+from nextmv.cli.options import ProfileOption
+from nextmv.cloud.sso import SSOConfiguration
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def get(
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the SSO configuration information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Get the information of a Nextmv Cloud SSO configuration.
+
+    This command is useful to get the attributes of an existing Nextmv Cloud
+    SSO configuration.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Get the SSO configuration.
+        $ [dim]nextmv cloud sso get[/dim]
+
+    - Get the SSO configuration and save the information to an [magenta]sso_config.json[/magenta] file.
+        $ [dim]nextmv cloud sso get --output sso_config.json[/dim]
+    """
+
+    client = build_client(profile)
+    in_progress(msg="Getting SSO configuration...")
+
+    sso_config = SSOConfiguration.get(client)
+    sso_config_dict = sso_config.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(sso_config_dict, f, indent=2)
+
+        success(msg=f"SSO configuration information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(sso_config_dict)

nextmv/cli/cloud/sso/update.py

@@ -0,0 +1,78 @@
+"""
+This module defines the cloud sso update command for the Nextmv CLI.
+"""
+
+import json
+from typing import Annotated
+
+import typer
+
+from nextmv.cli.configuration.config import build_sso_config
+from nextmv.cli.message import print_json, success
+from nextmv.cli.options import ProfileOption
+
+# Set up subcommand application.
+app = typer.Typer()
+
+
+@app.command()
+def update(
+    metadata_url: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-url",
+            "-u",
+            help="The URL to the SSO metadata document to update.",
+            metavar="METADATA_URL",
+        ),
+    ] = None,
+    metadata_document: Annotated[
+        str | None,
+        typer.Option(
+            "--metadata-document",
+            "-d",
+            help="The SSO metadata document as a string to update.",
+            metavar="METADATA_DOCUMENT",
+        ),
+    ] = None,
+    output: Annotated[
+        str | None,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Saves the updated SSO configuration information to this location.",
+            metavar="OUTPUT_PATH",
+        ),
+    ] = None,
+    profile: ProfileOption = None,
+) -> None:
+    """
+    Updates information of a Nextmv Cloud SSO configuration.
+
+    This command allows you to update the metadata URL or metadata document of
+    an existing SSO configuration.
+
+    [bold][underline]Examples[/underline][/bold]
+
+    - Update the SSO configuration with a new metadata URL.
+        $ [dim]nextmv cloud sso update --metadata-url "https://example.com/metadata.xml"[/dim]
+
+    - Update the SSO configuration with a new metadata document and save the updated information to an
+        [magenta]updated_sso_config.json[/magenta] file.
+        $ [dim]nextmv cloud sso update --metadata-document "<xml>...</xml>" --output updated_sso_config.json[/dim]
+    """
+
+    sso_config = build_sso_config(profile)
+    updated_config = sso_config.update(metadata_url=metadata_url, metadata_document=metadata_document)
+    success("SSO configuration updated successfully.")
+    updated_config_dict = updated_config.to_dict()
+
+    if output is not None and output != "":
+        with open(output, "w") as f:
+            json.dump(updated_config_dict, f, indent=2)
+
+        success(msg=f"Updated SSO configuration information saved to [magenta]{output}[/magenta].")
+
+        return
+
+    print_json(updated_config_dict)

nextmv/cli/community/__init__.py

@@ -9,8 +9,8 @@ from nextmv.cli.community.list import app as list_app
 
 # Set up subcommand application.
 app = typer.Typer()
-app.add_typer(list_app)
 app.add_typer(clone_app)
+app.add_typer(list_app)
 
 
 @app.callback()

nextmv/cli/configuration/config.py

@@ -12,6 +12,7 @@ from nextmv.cli.message import error, success, warning
 from nextmv.cloud.account import Account
 from nextmv.cloud.application import Application
 from nextmv.cloud.client import Client
+from nextmv.cloud.sso import SSOConfiguration
 
 # Some useful constants.
 CONFIG_DIR = Path.home() / ".nextmv"
@@ -207,6 +208,32 @@ def build_account(account_id: str | None = None, profile: str | None = None) ->
     return Account(account_id=account_id, client=client)
 
 
+def build_sso_config(profile: str | None = None) -> SSOConfiguration:
+    """
+    Builds a `cloud.SSOConfiguration` using the API key and endpoint for the given
+    profile. If no profile is given, the default profile is used.
+
+    Parameters
+    ----------
+    profile : str | None
+        The profile name to use. If None, the default profile is used.
+
+    Returns
+    -------
+    SSOConfiguration
+        An SSOConfiguration object for the configured profile.
+
+    Raises
+    ------
+    typer.Exit
+        If the configuration is invalid or missing.
+    """
+
+    client = build_client(profile)
+
+    return SSOConfiguration(client=client)
+
+
 def obscure_api_key(api_key: str) -> str:
     """
     Obscure an API key for display purposes.

nextmv/cloud/__init__.py

@@ -61,6 +61,7 @@ from .shadow import StartEvents as StartEvents
 from .shadow import StopIntent as StopIntent
 from .shadow import TerminationEvents as TerminationEvents
 from .shadow import TestComparison as TestComparison
+from .sso import SSOConfiguration as SSOConfiguration
 from .switchback import SwitchbackPlan as SwitchbackPlan
 from .switchback import SwitchbackPlanUnit as SwitchbackPlanUnit
 from .switchback import SwitchbackTest as SwitchbackTest

nextmv/cloud/account.py

@@ -188,30 +188,32 @@ class Account(BaseModel):
 
     You can import the `Account` class directly from `cloud`:
 
-    ```python
-    from nextmv.cloud import Account
-    ```
+    ```python from nextmv.cloud import Account ```
 
     This class provides access to account-level operations in the Nextmv Cloud,
     such as retrieving the queue of runs.
 
-    Note: It is recommended to use `Account.get()` or `Account.new()`
-    instead of direct initialization to ensure proper setup.
+    Note: It is recommended to use `Account.get()` or `Account.new()` instead
+    of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     account_id : str, optional
         ID of the account (organization).
     name : str, optional
         Name of the account (organization).
     members : list[AccountMember], optional
         List of members in the account (organization).
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an account.
     account_endpoint : str, default="v1/account"
-        Base endpoint for the account (SDK-specific).
+        Base endpoint for the account. This is an SDK-specific attribute and it
+        is not part of the API representation of an account.
     organization_endpoint : str, default="v1/organization/{organization_id}"
-        Base endpoint for organization operations (SDK-specific).
+        Base endpoint for organization operations. This is an SDK-specific
+        attribute and it is not part of the API representation of an account.
 
     Examples
     --------

nextmv/cloud/application/__init__.py

@@ -121,10 +121,8 @@ class Application(
     Note: It is recommended to use `Application.get()` or `Application.new()`
     instead of direct initialization to ensure proper setup.
 
-    Parameters
+    Attributes
     ----------
-    client : Client
-        Client to use for interacting with the Nextmv Cloud API.
     id : str
         ID of the application.
     name : str, optional
@@ -145,12 +143,19 @@ class Application(
         Creation timestamp of the application.
     updated_at : datetime, optional
         Last update timestamp of the application.
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an application.
     endpoint : str, default="v1/applications/{id}"
-        Base endpoint for the application (SDK-specific).
+        Base endpoint for the application. This is an SDK-specific attribute
+        and it is not part of the API representation of an application.
     experiments_endpoint : str, default="{base}/experiments"
-        Base endpoint for experiments (SDK-specific).
+        Base endpoint for experiments. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
     ensembles_endpoint : str, default="{base}/ensembles"
-        Base endpoint for ensembles (SDK-specific).
+        Base endpoint for ensembles. This is an SDK-specific attribute and it
+        is not part of the API representation of an application.
 
     Examples
     --------

nextmv/cloud/sso.py

@@ -0,0 +1,248 @@
+"""
+Single Sign-On (SSO) functionality for the Nextmv Cloud API.
+
+This module provides classes and methods to manage Single Sign-On (SSO)
+configurations for Nextmv Cloud organizations (accounts).
+
+Classes
+-------
+SSOConfiguration
+    Represents the SSO configuration for a Nextmv Cloud organization (account)
+    and provides methods to create, retrieve, update, enable, disable, and
+    delete SSO configurations.
+"""
+
+from pydantic import Field
+
+from nextmv.base_model import BaseModel
+from nextmv.cloud.client import Client
+
+
+class SSOConfiguration(BaseModel):
+    """
+    Configuration for Single Sign-On (SSO) in Nextmv Cloud.
+
+    You can import the `SSOConfiguration` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import SSOConfiguration
+    ```
+
+    Attributes
+    ----------
+    allow_non_domain_users : bool, optional
+        Whether to allow users who are not part of the SSO domain to access the
+        Nextmv Cloud organization (account). Default is `False`.
+    enabled : bool, optional
+        Whether SSO is enabled for the Nextmv Cloud organization (account).
+    metadata_url : str, optional
+        The URL to the SSO metadata document.
+    metadata_document : str, optional
+        The SSO metadata document as a string.
+    client : Client
+        Client to use for interacting with the Nextmv Cloud API. This is an
+        SDK-specific attribute and it is not part of the API representation of
+        an SSO configuration.
+    sso_endpoint : str
+        Base endpoint for SSO operations. This is an SDK-specific attribute and
+        it is not part of the API representation of an SSO configuration.
+    """
+
+    allow_non_domain_users: bool = False
+    """
+    Whether to allow users who are not part of the SSO domain to access the
+    Nextmv Cloud organization (account).
+    """
+
+    enabled: bool | None = None
+    """
+    Whether SSO is enabled for the Nextmv Cloud organization (account).
+    """
+    metadata_url: str | None = None
+    """
+    The URL to the SSO metadata document.
+    """
+    metadata_document: str | None = None
+    """
+    The SSO metadata document as a string.
+    """
+
+    # SDK-specific attributes for convenience when using methods.
+    client: Client = Field(exclude=True)
+    """Client to use for interacting with the Nextmv Cloud API."""
+    sso_endpoint: str = Field(exclude=True, default="/v1/enterprise/sso")
+
+    @classmethod
+    def get(cls, client: Client) -> "SSOConfiguration":
+        """
+        Retrieve the SSO configuration for the current Nextmv Cloud
+        organization (account).
+
+        Parameters
+        ----------
+        client : Client
+            Client to use for interacting with the Nextmv Cloud API.
+
+        Returns
+        -------
+        SSOConfiguration
+            The SSO configuration for the organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        response = client.request(
+            method="GET",
+            endpoint=cls.sso_endpoint,
+        )
+
+        return cls.from_dict({"client": client} | response.json())
+
+    @classmethod
+    def new(
+        cls,
+        client: Client,
+        allow_non_domain_users: bool = False,
+        enabled: bool | None = None,
+        metadata_url: str | None = None,
+        metadata_document: str | None = None,
+    ) -> "SSOConfiguration":
+        """
+        Create a new SSO configuration for the current Nextmv Cloud
+        organization (account).
+
+        Parameters
+        ----------
+        client : Client
+            Client to use for interacting with the Nextmv Cloud API.
+        allow_non_domain_users : bool, optional
+            Whether to allow users who are not part of the SSO domain to access
+            the Nextmv Cloud organization (account). Default is `False`.
+        enabled : bool, optional
+            Whether SSO is enabled for the Nextmv Cloud organization (account).
+        metadata_url : str, optional
+            The URL to the SSO metadata document.
+        metadata_document : str, optional
+            The SSO metadata document as a string.
+
+        Returns
+        -------
+        SSOConfiguration
+            The newly created SSO configuration for the organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        payload = {
+            "allow_non_domain_users": allow_non_domain_users,
+            "enabled": enabled,
+            "metadata_url": metadata_url,
+            "metadata_document": metadata_document,
+        }
+
+        response = client.request(
+            method="POST",
+            endpoint=cls.sso_endpoint,
+            json=payload,
+        )
+
+        return cls.from_dict({"client": client} | response.json())
+
+    def delete(self) -> None:
+        """
+        Delete the SSO configuration for the current Nextmv Cloud
+        organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        self.client.request(
+            method="DELETE",
+            endpoint=self.sso_endpoint,
+        )
+
+    def disable(self) -> None:
+        """
+        Disable SSO for the current Nextmv Cloud organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        self.client.request(
+            method="PUT",
+            endpoint=f"{self.sso_endpoint}/disable",
+        )
+
+    def enable(self) -> None:
+        """
+        Enable SSO for the current Nextmv Cloud organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        self.client.request(
+            method="PUT",
+            endpoint=f"{self.sso_endpoint}/enable",
+        )
+
+    def update(
+        self,
+        metadata_url: str | None = None,
+        metadata_document: str | None = None,
+    ) -> "SSOConfiguration":
+        """
+        Update the SSO configuration for the current Nextmv Cloud
+        organization (account).
+
+        If you wish to enable or disable SSO, please use the `enable` and
+        `disable` methods instead.
+
+        Parameters
+        ----------
+        metadata_url : str, optional
+            The URL to the SSO metadata document.
+        metadata_document : str, optional
+            The SSO metadata document as a string.
+
+        Returns
+        -------
+        SSOConfiguration
+            The updated SSO configuration for the organization (account).
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        config = self.get(self.client)
+        config_dict = config.to_dict()
+        payload = config_dict.copy()
+
+        if metadata_url is not None and metadata_url != "":
+            payload["metadata_url"] = metadata_url
+        if metadata_document is not None and metadata_document != "":
+            payload["metadata_document"] = metadata_document
+
+        response = self.client.request(
+            method="PUT",
+            endpoint=self.sso_endpoint,
+            json=payload,
+        )
+
+        return self.from_dict({"client": self.client} | response.json())

{nextmv-1.0.0.dev10.dist-info → nextmv-1.1.0.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0.dev10
+Version: 1.1.0.dev0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/

{nextmv-1.0.0.dev10.dist-info → nextmv-1.1.0.dev0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-nextmv/__about__.py,sha256=OuA1Ew1qq7c4njml2fR_IWNXf8n-DPf1oa_Nfx93r5E,29
+nextmv/__about__.py,sha256=sdMWpxPaxLx9snT2SjJ_Sjn3ddOnm-EdMGcDpyW0Zu0,28
 nextmv/__entrypoint__.py,sha256=XMT-ds1f2Yc6KoI2C0YEH-rJj5gVLfJMqUdRfcA3_KQ,1070
 nextmv/__init__.py,sha256=LwpGBSiV0UG13zKHO2N3Ikb7bCMV08Gfbl6Cp80b_2g,3813
 nextmv/_serialization.py,sha256=jYitMS1MU8ldsmObT-K_8V8P2Wx69tnDiEHCCgPGun4,2834
@@ -21,15 +21,15 @@ nextmv/cli/main.py,sha256=AwkIavXOAY-WmLA7F9eY2o6RWTOYHhgZiLs6WeqcB2E,5518
 nextmv/cli/message.py,sha256=NWeCmpkA_IEDay3Fu3YjNN9eSi3p8e-Tw9wp1qAjfXI,3809
 nextmv/cli/options.py,sha256=ymd6Y7_ZQkln35nHw3pLnFpqivgmJfuYAnyizmEuonc,6887
 nextmv/cli/version.py,sha256=VRbfNpUvCFYPcphr-F3Ph4Z4UwtVis4keyVFHj1JISw,681
-nextmv/cli/cloud/__init__.py,sha256=pywNNBy_poHaKn3_oIZRR9DDE8w3u65KvLpnX6S0BQI,1886
+nextmv/cli/cloud/__init__.py,sha256=0Ec_ettl3cHcLt_tgH6z1M1HGtADxdHLUBBwvmCj4rA,1969
 nextmv/cli/cloud/acceptance/__init__.py,sha256=v4U1m6z5zI8mQpmIE4kFeEYOsaDxnGRnRj2j5I6WueI,711
 nextmv/cli/cloud/acceptance/create.py,sha256=Mtiy7fMBU5Ay_hxb2DXxdaM2XvR_QDbldtyjQIAaelQ,14582
 nextmv/cli/cloud/acceptance/delete.py,sha256=htN7XqGudKhSrDpUwWhcb5VUp-sf4PTRZpqf5ObzAg8,2193
 nextmv/cli/cloud/acceptance/get.py,sha256=pb3hRdIiynTi4K7xDNCMJE7bW46FE-X3EoAQU8kQJjE,3438
 nextmv/cli/cloud/acceptance/list.py,sha256=9tTV4B2lgDqNxDnaNXkHxeh7jUQuAu9GQJsEKJ_NqIo,1881
 nextmv/cli/cloud/acceptance/update.py,sha256=ZyhYlkA7Sp0WWMewV774elwvjFKhyg-7jIE9L1yeipU,2912
-nextmv/cli/cloud/account/__init__.py,sha256=N3WqUHe48tBFWQ_I83EAgL_ng-y0tN6qHKROIMMxQhE,768
-nextmv/cli/cloud/account/create.py,sha256=V8f2zlGryBHKR3TBI3A7t9MSSaS8GHMClYquGQXqRrQ,2876
+nextmv/cli/cloud/account/__init__.py,sha256=-jKD2vNYCs1RKmJ5LmgYE8jnmwKnvCBPVeHSdNFkHx0,882
+nextmv/cli/cloud/account/create.py,sha256=D1jeUrPUgcWx4NnqxIJyI9hVkVa46k0tbGjSumfyWWw,3002
 nextmv/cli/cloud/account/delete.py,sha256=G6vblaHK21goNPIGRnTQyLDpZuPvRdMa5QEsZ566hF8,1828
 nextmv/cli/cloud/account/get.py,sha256=KT0Cs2ZQtZV4D0efAjMIj47RSKSSsU3-1ZApH8oYzLU,1860
 nextmv/cli/cloud/account/update.py,sha256=z_g_uEAgBJDcb0Kh80NbKTA7gycrJb6hHjJPVG9wEVw,2124
@@ -106,6 +106,13 @@ nextmv/cli/cloud/shadow/metadata.py,sha256=vHJYVDXXHwiqQrG0J0D_aRP--b47UfEgJwJOX
 nextmv/cli/cloud/shadow/start.py,sha256=SkDYSfyQLdfHJKCOzc4CW6MVO7YBWCZCOAoGBzqSFhI,1464
 nextmv/cli/cloud/shadow/stop.py,sha256=WNg73nHkQ6Mo7hdg3qfSXQBkd77iKPfRIdSSJxTHhTY,1706
 nextmv/cli/cloud/shadow/update.py,sha256=l7_gODO9fXYGOLzFMJmIVpT5Jku9XQAo2PI5x3AP4xU,2880
+nextmv/cli/cloud/sso/__init__.py,sha256=30jM1Qh9L1fQIctcnT5xcHUggismEYsIhHIsxgrI4_I,919
+nextmv/cli/cloud/sso/create.py,sha256=bF04XZ-dEFsDEsVIjVtMNP3UH83x5XyLA6vt8ITuNbg,3325
+nextmv/cli/cloud/sso/delete.py,sha256=5mB9t8UcHTuN8WEPbrJG93Ai9uGXOzfInK7fb_IL8pc,1563
+nextmv/cli/cloud/sso/disable.py,sha256=Juv6xC6qMlQrG_C_c-s7V4FqepPzbueKifNeX6RwZ0w,1464
+nextmv/cli/cloud/sso/enable.py,sha256=OH2Yyz8RHhYDNG4o2ABT23k4Hdd9iBnJTbf8JVq7mf4,1451
+nextmv/cli/cloud/sso/get.py,sha256=odfcoggvMOgDT9VUtji-wUMysCEgaHnqjAsrVr1SmMk,1644
+nextmv/cli/cloud/sso/update.py,sha256=u4Z_Ejr0612EXwvBVJZpJA_p6PP763BNUXCuQTNp_yY,2404
 nextmv/cli/cloud/switchback/__init__.py,sha256=jYeujjbqvqRGIgvC0wr3I6zavw1az7IS8jiJsAlH-z4,981
 nextmv/cli/cloud/switchback/create.py,sha256=lEboNjN1ZFbuOCFmK2ADIRH-pIENc80NcR809rDOY3I,5085
 nextmv/cli/cloud/switchback/delete.py,sha256=W0TWsYw0MI23MbN8Oj6lQn7K7jEafY1dWW4HVMooyeY,2186
@@ -124,17 +131,17 @@ nextmv/cli/cloud/version/exists.py,sha256=DAWP-3n_yaqqxtQAWBwhSziMYJifFEdydfOmsv
 nextmv/cli/cloud/version/get.py,sha256=eGbka3TG8UJE150h22rn0BUqTi1xRE7roVDj6yJvnRY,1839
 nextmv/cli/cloud/version/list.py,sha256=sKdHgyowLG1jyUEtu87yCPC5_2-0i3VDEgfmvb-bBn0,1770
 nextmv/cli/cloud/version/update.py,sha256=mEUYXGHLGkiEGH31KK6jDDfviHEhVCdLjLQL_5u0vLk,2869
-nextmv/cli/community/__init__.py,sha256=t2l6adm9Km6hSvSFzeKHTQzacVSnwjx4wpj2kqee5nM,612
+nextmv/cli/community/__init__.py,sha256=FJRlBlIC4y-npgh9HNz2wezecq8vfsYWo2MAQdUj1UM,612
 nextmv/cli/community/clone.py,sha256=_I1C58pKmfAHdl-8eaZDeaxZm2Rnp2en8PCPdflAse4,2912
 nextmv/cli/community/list.py,sha256=Gf9E-wD-0GQcaTPGBNp8p_zX44UAL5bYG6LKroTKLCU,5807
 nextmv/cli/configuration/__init__.py,sha256=7oryF4PKkORh8bcdgbN2k36rZrFpJsM7Xfq_J4-MkFs,516
-nextmv/cli/configuration/config.py,sha256=t43ubCcbfbpfq9HvkVb2WQY9V47lrLEP0KvsWfjOJ8Y,6667
+nextmv/cli/configuration/config.py,sha256=6NM537xHrmUruFRtrXkhE3OI0XFRAnCaSJDEfG_AtHw,7356
 nextmv/cli/configuration/create.py,sha256=lTOxE-38BO7qed1I-wlJ8Ey1WHGMTPbGMozncW8xizM,2737
 nextmv/cli/configuration/delete.py,sha256=-3IL0nh367D0NhIdPXOCCCAWhejABS8QIfOcoH_cW-M,1915
 nextmv/cli/configuration/list.py,sha256=HIZvDJQW5B0-o_ZqQHuxRw7N_VmxqYM46fucKCvo1zw,2208
-nextmv/cloud/__init__.py,sha256=IW9fdg3QgusJGAU4VVEu5qkCidzalyYf4wjC1T14rnQ,4183
+nextmv/cloud/__init__.py,sha256=8zrGJ-UYusPgBz87CnUNEteiU-V475EOFStGPQWFNYY,4237
 nextmv/cloud/acceptance_test.py,sha256=H34lvccJzN1URpnhrHstcVxgvq1s2iCymiKIPBHcToY,25828
-nextmv/cloud/account.py,sha256=X2xQjzhgEdKR0eypH8lWKUOwDISjJSd5SwOwEnpfTVk,13573
+nextmv/cloud/account.py,sha256=y1fNj7Y1ghQ3r9nIkpSFlmsTsCaN1ZzOfEOHkjavvoE,13849
 nextmv/cloud/assets.py,sha256=alw634ub-DR0CHQXZy_ObeGvQthPXFLdgzgbvbH1SGY,1376
 nextmv/cloud/batch_experiment.py,sha256=flwP5pbBio-ilAbopj8DdSWOlxGbct1IOElsgcyVN8U,10545
 nextmv/cloud/client.py,sha256=Yj4FE4GKsLHkYijAYXcotlyNfhAWANMuWetHXsYPg1M,18101
@@ -147,10 +154,11 @@ nextmv/cloud/package.py,sha256=88XSJ15QGcHboNJAw2hGowiLKBu2O2nV5ZieZFx7XDI,17133
 nextmv/cloud/scenario.py,sha256=1_4PI9ehYaSonEe_l59cFhZNmqQ_brXXP6-mVq9i8a8,14183
 nextmv/cloud/secrets.py,sha256=fA5cX0jfTsPVZWV7433wzETGlXpWRLHGswuObx9e6FQ,6820
 nextmv/cloud/shadow.py,sha256=U-s9alkDS3wmYCEVDKEvuceveWOZOiF7rkH4_8eKdNk,7711
+nextmv/cloud/sso.py,sha256=FaLE-e-xMrbXgTJbD-Mti4knroGWU4XGroZKPRCJsWk,7325
 nextmv/cloud/switchback.py,sha256=6e4J5zCewgGaitB5iJiO3u6BPHcAlzdAB5WU8j2b4K8,7427
 nextmv/cloud/url.py,sha256=Fz70ywkWdCLmP21ZBmJwZi5kDbjpmsX_VlwVF_xQeHg,1836
 nextmv/cloud/version.py,sha256=5_S7_pWUVBFbvAArku20eK7S645GJcHtgE2OpXLdSzQ,5300
-nextmv/cloud/application/__init__.py,sha256=x9khEFlWUdupBxzMuSyrCftopNtrK64LTTEaCRSRwyM,32712
+nextmv/cloud/application/__init__.py,sha256=_f8AKvw3VY5d8MtM1JMao6kbVafZWiLi7cKJilzP0ik,33099
 nextmv/cloud/application/_acceptance.py,sha256=PEkf9cDunK40UNw96QBhpJpH5SOFLZMtmnyX84uAo9k,13974
 nextmv/cloud/application/_batch_scenario.py,sha256=cSsX5vPOkm91UqRBPIcqlOvQ0iojwt4sQKYGZEE7x6k,28479
 nextmv/cloud/application/_ensemble.py,sha256=05l9uR0hTnW8nQjhRzjd2TPfvCoaAqNddWP-aVRL5rg,7666
@@ -178,8 +186,8 @@ nextmv/local/geojson_handler.py,sha256=7FavJdkUonop-yskjis0x3qFGB8A5wZyoBUblw-bV
 nextmv/local/local.py,sha256=cp56UpI8h19Ob6Jvb_Ni0ceXH5Vv3ET_iPTDe6ftq3Y,2617
 nextmv/local/plotly_handler.py,sha256=bLb50e3AkVr_W-F6S7lXfeRdN60mG2jk3UElNmhoMWU,1930
 nextmv/local/runner.py,sha256=bM1dFIAG4f9pEtbyevzkRa9nSppqTeD8naomNzJVBRU,8560
-nextmv-1.0.0.dev10.dist-info/METADATA,sha256=La1768YqfIVx_d8aYji252SX5eDvYEHS7CkloJwIGoc,16526
-nextmv-1.0.0.dev10.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nextmv-1.0.0.dev10.dist-info/entry_points.txt,sha256=bH7kXUt_IOLpeW_O7Z-J2gALs2YYJ4CmWuzS8MdK6uY,48
-nextmv-1.0.0.dev10.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
-nextmv-1.0.0.dev10.dist-info/RECORD,,
+nextmv-1.1.0.dev0.dist-info/METADATA,sha256=PBdBO9bnlZQoMLvyHFiEfoErbhGp3EKZzOMZ9e5TwIw,16525
+nextmv-1.1.0.dev0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nextmv-1.1.0.dev0.dist-info/entry_points.txt,sha256=bH7kXUt_IOLpeW_O7Z-J2gALs2YYJ4CmWuzS8MdK6uY,48
+nextmv-1.1.0.dev0.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
+nextmv-1.1.0.dev0.dist-info/RECORD,,