This guide walks you through how to assign single sign on (SSO) for a client and enter their authentication details. This works in the same way as SSO for the payslip portal.
If clients are asking what information they need, they can access Single sign on - a client guide
Table of Contents
What authentication methods are supported?
What information does RSM need? Anchor What information does RSM need? What information does RSM need?
| What information does RSM need? | |
| What information does RSM need? |
The OpenID Connect Configuration URL
The Client ID (This may show as Application ID in your identity provider)
The Client Secret
Optionally, your public key
What authentication methods are supported?Anchor What authentication methods are supported? What authentication methods are supported?
| What authentication methods are supported? | |
| What authentication methods are supported? |
OAuth 2.0
OpenID Connect
How to set it upAnchor How to set it up How to set it up
| How to set it up | |
| How to set it up |
Go to admin in the top menu heading and select client SSO, then in the client field find the client.
Metadata
This field you You will need to enter OpenID connect configuration URL
Options
Enable SSO - Once this is checked, all client portal users with a matching email suffix 1 or 2 will be able to login by SSO. Please note: If this is checked (even if other details are left blank) employees will have a client portal user created using their email address against their record.
Validate issuer - This may be checked if the company wished to validate the issuer. They will need to configure their authentication to provide an issuer matching the issuer.
Validation
Issuer if If the validate issuer is checked, the returned issuer must match this value.
Claims
The client portal supports two claims. If none are entered or available, the default identity name will attempt to be matched to the users user's client portal email address. Check the log after a failed attempted SSO login to see available claims.
Email claim - The name of the claim that will contain the users client portal email address. For example @RSMUK.COMmost setups, this will be email
Unique Id claim - The name of the claim that will contain a unique identifier for the user. This may also contain the users email or a unique id for the user. It will be used to verify the user in addition to the email after the first login. For most setups, this will be email
Identification
Client id - This allows the company's authentication provider to identify the client portal and use the correct configuration.
...
Certificate - The public certificate used to validated validate the returned token if if Validate Audience or Validate Issuer are checked. Not required for OpenID Connect.
...
Client secret - This is the most sensitive piece of data entered on this page. The company must provide this by secure means (E.G., a Client Portal client portal message). After populating this field and saving, it's not possible to view the value.
...
Authorization Endpoint If a username is entered on the login screen of a user that has an email with a suffix matching one of the provided suffixes, they will be sent to this address. They will then log in to their company account and be sent back to InPay with a code. After saving the setup for the first time, ensure that this URL loads showing a login page. If not, there will be an issue with the setup on the clients side.
Sharing details with clients and logging
...
Once a user is returned from the Authorization Endpoint, the request will be logged showing any issues.
FAQAnchor FAQ FAQ
| FAQ | |
| FAQ |
Unable to get claims. Ask client to add a claim named UserID to return the users email address.
First try checking Validate Issuer. The claims returned are affected by this setting.
User can't login by SSO
If a user is unable to login by SSO once enabled, first:
- Check the log for any error messages to forward to support
- Check that the users email address is correct and ends with the text in Email Suffix 1 or Email Suffix 2
- Advise the user to register
- email suffix
If they're using Azure (the meta data url will start with login.microsoft...), are still having issues and you're seeing large amounts of text in the log. Ensure the client has added the email claim by sending these instructions:
...
Once they've completed these steps, set the Email Claim and Unique Id Claim in InPay to email.
Do you support SAML or SAML 2.0?
...
- "google openId Connect": https://developers.google.com/identity/protocols/oauth2/openid-connect
- "oracle idcs openid connect": https://blogs.oracle.com/developers/authenticating-users-with-oracle-idcs-via-openid-connect-and-micronaut
The client would like some instructions
See Single Sign On, this will be of use even if they are using a different provider.
...
First confirm the Payslip Portal users saved email address is correct. If so, forward the error messages to the company's internal IT department.
Error message showing token response with no email
...
Once a user has logged in once, their username will be populated on subsequent attempts (it’s stored in a cookie).The closest we can get to populating on the first attempt is to put the username into the address E.G. https://inpay.es.rsmuk.com/payslipportal4/?username=support@in-time.co.uk
We don’t currently support IdP-Initiated SSO. This is where they would have an address for their SSO provider E.G. inpay.es.rsmuk.com/payslipportal4/?sso=CompanyName