Configure Single Sign-On (SSO)

Apty Assist supports single sign-on authentication, which is a process that allows a user to access multiple applications with one set of login credentials. Apty supports 2 types of SSO Authentication: OAuth 2.0 and SAML 2.0.

This article covers the following instructions:

To setup OAuth:

OAuth 2 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service, such as Facebook, GitHub, and DigitalOcean. It works by delegating user authentication to the service that hosts the user account, and authorizing third-party applications to access the user account. OAuth 2 provides authorization flows for web and desktop applications, and mobile devices.

SSO Type
Select "OAth" from the drop-down list.


HOST_NAME (SS REDIRECT URL)

Apty Assist URI where the application is deployed. SSO config Host name should match with present host name. For example: https://companyname.apty.io 

Client ID
Public identifier for apps; usually consists of 32 character hex string.


Client Secret
A cryptographically secure string which is only known by the application and authorization server.


Scopes
Requesting for the required details in success response from the Identity Provider; for example, openid, profile, offline_access, name, given_name, created_at, etc. For details refer to this source.


Auth URL
String path to request an authorization code. Default to /oauth/authorize.


Token URL
Identity provider base URI.


Email Key
JSON key of the Authorization Success Response through which the Authorized User Email can be accessed.


To setup SAML:

SAML SSO works by transferring the user’s identity from one place (the identity provider) to another (the service provider). This is done through an exchange of digitally signed XML documents. Consider the following scenario: A user is logged into a system that acts as an identity provider. The user wants to log in to a remote application, such as a support or accounting application (the service provider). The following happens:

  1. The user accesses the remote application using a link on an intranet, a bookmark, or similar and the application loads.
  2. The application identifies the user’s origin (by application subdomain, user IP address, or similar) and redirects the user back to the identity provider, asking for authentication. This is the authentication request.
  3. The user either has an existing active browser session with the identity provider or establishes one by logging into the identity provider.
  4. The identity provider builds the authentication response in the form of an XML-document containing the user’s username or email address, signs it using an X.509 certificate, and posts this information to the service provider.
  5. The service provider, which already knows the identity provider and has a certificate fingerprint, retrieves the authentication response and validates it using the certificate fingerprint.
  6. The identity of the user is established and the user is provided with app access.
SSO Type
Select "SAML" from the drop-down list. 


HOST_NAME (SS REDIRECT URL)

Apty Assist URI where the application is deployed. SSO config Host name should match with present host name. For example: https://companyname.apty.io 

Meta Data URL
A link to the identity provider's metadata file (if applicable).


Email Key
JSON key of the Authorization Success Response through which the Authorized User Email can be accessed.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.