authorized_domains

authorized_domains

GetAppDomainsNotFoundError

GetAppDomainsNotFoundError(
    res: ResponseGetData, message: str = ""
)

Bases: Config_GET_Error

Raised when authorized custom app domains retrieval fails.

This exception is used for failures during GET operations on authorized custom app domains, including API errors and unexpected response formats.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

def __init__(self, res: rgd.ResponseGetData, message: str = ""):
    super().__init__(res=res, message=message)

GetDomainsNotFoundError

GetDomainsNotFoundError(
    res: ResponseGetData, message: str = ""
)

Bases: Config_GET_Error

Raised when authorized domains retrieval fails.

This exception is used for failures during GET operations on authorized domains, including API errors and unexpected response formats.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

def __init__(self, res: rgd.ResponseGetData, message: str = ""):
    super().__init__(res=res, message=message)

get_authorized_custom_app_domains async

get_authorized_custom_app_domains(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v1/customer-states/authorized-app-domains - Retrieve authorized custom app domains.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed list of domain strings.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the response. The response field contains
ResponseGetData	a list of domain strings when return_raw is False, or the raw API response
ResponseGetData	when return_raw is True.

Raises:

Type	Description
GetAppDomainsNotFoundError	If the API request fails or returns an error status.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_authorized_custom_app_domains(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v1/customer-states/authorized-app-domains - Retrieve authorized custom app domains.

    Args:
        auth: Authentication object containing Domo credentials.
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed list of domain strings.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the response. The response field contains
        a list of domain strings when return_raw is False, or the raw API response
        when return_raw is True.

    Raises:
        GetAppDomainsNotFoundError: If the API request fails or returns an error status.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/authorized-app-domains"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    # domo raises a 404 error even if the success is valid but there are no approved domains
    if res.status == 404 and res.response == "Not Found":
        res_test = await user_routes.get_all_users(auth=auth, context=context)

        if not res_test.is_success:
            raise GetAppDomainsNotFoundError(res=res)

        if res_test.is_success:
            res.status = 200
            res.is_success = True
            res.response = []

        return res

    if not res.is_success:
        raise GetAppDomainsNotFoundError(res=res)

    res.response = [domain.strip() for domain in res.response.get("value").split(",")]  # type: ignore
    return res

get_authorized_domains async

get_authorized_domains(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v1/customer-states/authorized-domains - Retrieve authorized domains.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed list of domain strings.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the response. The response field contains
ResponseGetData	a list of domain strings when return_raw is False, or the raw API response
ResponseGetData	when return_raw is True.

Raises:

Type	Description
GetDomainsNotFoundError	If the API request fails or returns an error status.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_authorized_domains(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v1/customer-states/authorized-domains - Retrieve authorized domains.

    Args:
        auth: Authentication object containing Domo credentials.
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed list of domain strings.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the response. The response field contains
        a list of domain strings when return_raw is False, or the raw API response
        when return_raw is True.

    Raises:
        GetDomainsNotFoundError: If the API request fails or returns an error status.
    """
    # get-domains + (on 404) get-all-users reuse one pooled session via
    # auth-level connection reuse (RouteContext.reuse_session, default on).
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/authorized-domains"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    # domo raises a 404 error even if the success is valid but there are no approved domains
    if res.status == 404 and res.response == "Not Found":
        res_test = await user_routes.get_all_users(auth=auth, context=context)

        if not res_test.is_success:
            raise GetDomainsNotFoundError(res=res)

        if res_test.is_success:
            res.status = 200
            res.is_success = True
            res.response = []

        return res

    if not res.is_success:
        raise GetDomainsNotFoundError(res=res)

    res.response = [domain.strip() for domain in res.response.get("value").split(",")]  # type: ignore
    return res

set_authorized_custom_app_domains async

set_authorized_custom_app_domains(
    auth: DomoAuth,
    authorized_custom_app_domain_ls: list[str],
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/customer-states/authorized-app-domains - Set authorized custom app domains.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
authorized_custom_app_domain_ls	list[str]	List of custom app domain strings to authorize.	required
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the result of retrieving the updated
ResponseGetData	authorized custom app domains list.

Raises:

Type	Description
Config_CRUD_Error	If the API request fails.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def set_authorized_custom_app_domains(
    auth: DomoAuth,
    authorized_custom_app_domain_ls: list[str],
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/customer-states/authorized-app-domains - Set authorized custom app domains.

    Args:
        auth: Authentication object containing Domo credentials.
        authorized_custom_app_domain_ls: List of custom app domain strings to authorize.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the result of retrieving the updated
        authorized custom app domains list.

    Raises:
        Config_CRUD_Error: If the API request fails.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/authorized-app-domains"

    body = {
        "name": "authorized-app-domains",
        "value": ",".join(authorized_custom_app_domain_ls),
    }

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body,
        context=context,
    )

    if not res.is_success:
        raise Config_CRUD_Error(res=res)

    return await get_authorized_custom_app_domains(
        auth=auth,
        context=context,
    )

set_authorized_domains async

set_authorized_domains(
    auth: DomoAuth,
    authorized_domain_ls: list[str],
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/customer-states/authorized-domains - Set authorized domains.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
authorized_domain_ls	list[str]	List of domain strings to authorize.	required
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the result of retrieving the updated
ResponseGetData	authorized domains list.

Raises:

Type	Description
Config_CRUD_Error	If the API request fails.

Source code in src/crew_dcs/routes/instance_config/authorized_domains.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def set_authorized_domains(
    auth: DomoAuth,
    authorized_domain_ls: list[str],
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/customer-states/authorized-domains - Set authorized domains.

    Args:
        auth: Authentication object containing Domo credentials.
        authorized_domain_ls: List of domain strings to authorize.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the result of retrieving the updated
        authorized domains list.

    Raises:
        Config_CRUD_Error: If the API request fails.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/authorized-domains"

    body = {"name": "authorized-domains", "value": ",".join(authorized_domain_ls)}

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body,
        context=context,
    )

    if not res.is_success:
        raise Config_CRUD_Error(res=res)

    return await get_authorized_domains(
        auth=auth,
        context=context,
    )