Basic authentication

  • Release version: Yokohama
  • Updated March 12, 2026
  • 1 minute to read

    • Legacy API authentication method using username and password, with restricted usage and varying behaviour in zBoot and upgraded instances.

    Basic authentication is a legacy method for authenticating API requests using a username and password combination. While it remains available for compatibility in certain scenarios, its use is strongly discouraged over token-based authentication methods.

    Basic authentication should only be used in limited scenarios where alternative methods aren't viable. To learn more about the basic authentication restrictions, review this KB article.

    Behaviour across instance scenarios

    The behaviour of basic authentication varies depending on how an instance is provisioned or upgraded.

    zBoot instances (newly provisioned instances)
    In zBoot scenarios, basic authentication is restricted by default to improve security.
    • Basic authentication may be blocked unless specific conditions are met
    • Access may be limited to users with required roles or permissions
    • Enforcement is stricter compared to upgraded instances

    These restrictions minimises exposure to insecure authentication methods and encourage adoption of modern alternatives.

    Upgraded instances
    In upgraded instances, basic authentication may continue to function under certain conditions to support backward compatibility.
    • Existing integrations using basic authentication may continue to work
    • Restrictions may be applied gradually depending on patch or upgrade level
    • Behaviour may differ based on system configuration and applied changes

    This approach allows existing users to transition to more secure authentication mechanisms without immediate disruption.