Header-based authentication
- Last Updated: May 13, 2026
- 1 minute read
- Semaphore
- Documentation
Header authentication requires that an external authentication mechanism be used to authenticate the user. Once authenticated then any request to Semaphore Studio should include the two (request) header elements:
- X-User - The name of the authenticated user.
- X-Role - The role (as per “Access level security”, below) for the user. If the user is assigned to multiple roles then multiple “X-Role” headers should be sent containing each role.
Note: The header element names are configured in the <Studio Installation Directory>/conf/auth/auth.properties configuration file in the “header authentication” section settings “headers.user” and “headers.role”. The values given above are the default so if the configuration is changed the header elements should also change appropriately.