SSO module¶

@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="v1/enterprise/sso",
    )
    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,
) -> None:
    """
    Create a new SSO configuration for the current Nextmv Cloud
    organization (account).

    This method does not return the created configuration. To retrieve
    the configuration after creation, use the `get` method.

    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.

    Raises
    ------
    requests.HTTPError
        If the response status code is not 2xx.
    """

    metadata_document = _resolve_metadata_document(metadata_document)

    payload = {
        "allow_non_domain_users": allow_non_domain_users,
        "enabled": enabled,
        "metadata_url": metadata_url,
        "metadata_document": metadata_document,
    }

    client.request(
        method="POST",
        endpoint="v1/enterprise/sso",
        payload=payload,
    )

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 delete_domain(self, domain: str) -> None:
    """
    Deletes a domain from an existing 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=f"{self.sso_endpoint}/domains/{domain}",
    )

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,
) -> None:
    """
    Update the SSO configuration for the current Nextmv Cloud
    organization (account).

    This method does not return the updated configuration. To retrieve the
    configuration after updating, use the `get` method. 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.

    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 != "":
        metadata_document = _resolve_metadata_document(metadata_document)
        payload["metadata_document"] = metadata_document

    self.client.request(
        method="PUT",
        endpoint=self.sso_endpoint,
        payload=payload,
    )