Step 1: Prerequisites
Access to OrangeHRM: You should have administrative access to your OrangeHRM instance.
SAML Identity Provider: Choose a SAML 2.0 compliant Identity Provider. Popular options include Okta, Azure, or any other SAML-compliant system.
Step 2: Configure Identity Provider (IdP)
- Create a New SAML Application:
- Log in to your IdP's admin console.
- Create a new SAML application.
- Provide the parameters below to the client
- Entity ID (Issuer)
- Assertion Consumer Service (ACS) URL
- Single Logout (SLO) URL (optional)
Configure SAML Attributes:
- Define the necessary SAML attributes, such as NameID and user attributes like email or username.
Download IdP Metadata:
- Download the IdP metadata file provided by your IdP. This file typically contains important configuration details.
Step 3: Configure OrangeHRM
- Access OrangeHRM:
- Log in to your OrangeHRM instance as a system administrator.
Go to HR Administration -> Configuration -> Authentication -> SAML
- Click on the Add button and, from the dropdown, select External IdP
Enable SAML:
Enable the SAML authentication option.
- Upload IdP Metadata:
If your IdP provided a metadata file, upload it to the OrangeHRM SAML settings.
- Map SAML Attributes:
Map OrangeHRM fields to the corresponding attributes from your IdP (e.g., map email, username).
- Save and Test
Save the SAML settings.
Test the configuration by attempting to log in with a user account associated with the IdP.
Note - If you do not have access to system configurations, please reach out to goldsupport@orangehrm.com for assistance.
Step 5: Troubleshooting
- Logs:
- Check logs in OrangeHRM and your IdP for any error messages.
- Attribute Mismatch:
- Confirm that the SAML attributes are correctly mapped between OrangeHRM and the IdP.
- URLs:
- Double-check that all URLs (ACS, SSO, SLO) are accurate and accessible.
- Metadata:
- Ensure that the metadata exchanged between OrangeHRM and the IdP is correct.