...

By the end of this manual, you will have successfully integrated your Identity Provider with GYTPOLSaaS, marking a significant milestone in enhancing your organization's security infrastructure. Let's embark on this journey together, towards a more secure and efficient digital environment.

Anchor
_n3baf0dl398y _n3baf0dl398y

Prerequisites for Integration

Before you begin the integration process of your Identity Provider (IdP) with GYTPOL SaaS, it's essential to have everything in place for a smooth and successful setup. This section outlines all the necessary prerequisites to ensure that you are fully prepared. Please ensure that you have the following before proceeding:

...

Familiarity with Your IdP's Configuration Process: While this manual will guide you through the general steps for integration, IdPs can vary significantly in their specific configuration processes. Having a basic understanding of how to navigate and make changes in your IdP will be beneficial. If you're unfamiliar, consider reviewing your IdP's documentation or reaching out to their support team for guidance.

...

Anchor
_nylgd3lh7yww _nylgd3lh7yww

Step-by-Step Integration Guide

Anchor
_dg7ku8spk6fw _dg7ku8spk6fw

Azure AD

Anchor
_6hvwpk7vd80q _6hvwpk7vd80q

Add Amazon Cognito as an enterprise application in Azure AD

In this step, you add an Amazon Cognito user pool as an application in Azure AD, to establish a trust relationship between them.

Anchor
_2v8v334poj6j _2v8v334poj6j

To add new application in Azure AD

1. Log in to the Azure Portal.

2. In the Azure Services section, choose Azure Active Directory.

3. In the left sidebar, choose Enterprise applications.

4. Choose New application.

5. On the Browse Azure AD Gallery page, choose Create your own application.

6. Under What’s the name of your app?, enter a name for your application and select Integrate any other application you don’t find in the gallery (Non-gallery), as shown in Figure 1.

7. Choose Create.
   

   Image Removed

   Image Added

After creating the application in Azure AD, it may take a few moments for the process to complete. Once finished, you will be automatically redirected to the Overview page for the newly added application.

Please note that there is a possibility of encountering a Not Found error during this step, even if Azure AD has successfully created the new application. In such cases, you can navigate back to Enterprise applications in Azure AD and search for your application by its name to locate it.

Anchor
_utpf0zrtv9jk _utpf0zrtv9jk

To set up Single Sign-on using SAML

1. On the Getting started page, in the Set up single sign on tile, choose Get started, as shown in Figure 2.

   Image RemovedImage Added

2. Proceed to the next screen and select SAML.

3. In the middle pane, navigate to the Basic SAML Configuration section, and click on the edit icon.

4. In the right pane, within the Basic SAML Configuration, replace the default Identifier ID (Entity ID) with the Identifier (Entity ID) provided by your account manager. Then, in the Reply URL (Assertion Consumer Service URL) field, input the Reply URL provided by your account manager, as depicted in Figure 3. Click on Save to confirm the changes.

   Image RemovedImage Added

5. In the middle pane under Set up Single Sign-On with SAML, in the User Attributes & Claims section, choose Edit.

6. Choose Add a group claim.

7. On the User Attributes & Claims page, in the right pane under Group Claims, select Groups assigned to the application, leave Source attribute as sAMAccountName, as shown in Figure 4.

8. Expand the Advanced options mark the “Customize the name of the group claim” checkbox. Write “groups” in the Name field, as shown in Figure 4 and Choose Save. This will allow automatic GYTPOL roles mapping to Azure AD groups.
   

   

9. Scroll down to the SAML Signing Certificate section and copy the App Federation Metadata URL by choosing the copy into clipboard icon (highlighted with red arrow in Figure 5).

10. Please send the URL to your account manager.

    Image RemovedImage Added

11. Assign the application to the relevant groups.

...

Anchor
_sj8wbm2igucc _sj8wbm2igucc

Okta

Anchor
_mtb4z6701vv3 _mtb4z6701vv3

Configure SAML integration for your Okta app

Create a new App Integration and select SAML 2.0

...

1. Under General Settings, enter a name for your app.

2. (Optional) Upload a logo and choose the visibility settings for your app.

3. Choose Next.

4. Under General, for Single sign on URL, enter the Single sign-on URL provided by your account manager (as Reply URL) and Audience URI (SP Entity ID) which was also provided by your account manager,as shown in Figure 2.

...

Under Attribute Statements (optional), add a statement with the following information, as shown in Figure 3:

...

1. For all other settings on the page, leave them as their default values or set them according to your preferences.

2. Choose Next.

3. Choose a feedback response for Okta Support.

4. Choose Finish.

5. Open the application and under the Sign On page, copy the Metadata-URL and send it to your account manager, as shown in Figure 4.

   Image RemovedImage Added

Anchor
_j196whyi9n3l _j196whyi9n3l

Assign a user to your Okta application

1. On the Assignments tab for your Okta app, for Assign, choose Assign to People.

2. Choose Assign next to the user that you want to assign.
   Note: If this is a new account, the only option available is to choose yourself (the admin) as the user.

3. Choose Save and Go Back. Your user is assigned.

4. Choose Doneis to choose yourself (the admin) as the user.

5. Choose Save and Go Back. Your user is assigned.

6. Choose Done.

Google Workspace

Create Web App

1. Begin by creating a new web application.

2. Provide a name for the application.

3. Download the metadata XML file and then upload it to a publicly accessible URL. Please share the URL with your designated account manager at GYTPOL.

...

5. On the subsequent page, fill in the ACS URL with the Single Sign-On (SSO) URL provided by your account manager, along with the Entity ID, also provided by your account manager.

6. Adjust the Name ID format to EMAIL.

...

6. Map the primary email to the claim URL: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.

7. Map the First name to the claim URL: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname.

8. Map the Last name to the claim URL: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname.

...

9. To map Google Workspace groups to GYTPOL roles, follow these steps:

   1. Select the desired groups under "Google Groups".

   2. Change the "App attribute" to "groups" (lowercase).

10. Once completed, click on "Finish" to save the changes.

To assign the web application to your users or groups, follow these steps:

1. Navigate to your newly created web application.

2. Click on "User access".

...

3. Choose the group or users you want to enable the GYTPOL app for, then check the ON checkbox to activate it.

...

4. After selecting the desired group or users and activating the GYTPOL app by marking the ON checkbox, click on the SAVE button to confirm your changes.

PingFederate

Integrating Ping Federate with another application involves several steps. These steps assume that you have already received the Reply URL (Assertion Consumer Service URL) and Entity ID from GYTPOL.

Here's a general outline of the process:

1. Set Up PingFederate as an Identity Provider (IdP):

   • Log in to the PingFederate administrative console.

2. Create an IdP Connection:

   • Navigate to the "Identity Provider" tab.

   • Select "Create New" under "SP Connections".

   • Choose "Browser SSO Profiles" and proceed with the "Next" button.

3. Basic Information:

   • Enter a connection name and an optional description.

   • Click "Next".

4. Connection Type:

   • Select the connection type. Choose "Browser SSO Profiles".

   • Click "Next".

5. Import Metadata:

   • Select "Manual Configuration" and click "Next".

6. Configure the Connection:

   • Connection Options:

     • Choose SAML 2.0 and proceed.

   • Connection Configuration:

     • Enter the Entity ID (e.g., urn:amazon:cognito:sp:eu-central-1_q1W2e3R4).

     • Enter the Assertion Consumer Service (ACS) URL (Reply URL) (e.g., https://gytpol-saas-tenant-name.auth.eu-central-1.amazoncognito.com/saml2/idpresponse

   • SAML Profiles:

     • Enable the SAML profiles required (e.g., SP-initiated SSO).

   • Assertion Lifetime:

     • Set the assertion validity period (default is usually sufficient).

   • Signature Policy:

     • Configure signing options based on SP requirements.

7. Attribute Mapping:

   • Map the attributes from your IdP to the attributes expected by the SP. Common attributes include names, email, and others. Please refer to the below screenshots for reference.

   • Click "Next".

...

8. Summary:

   • Review the configuration and click "Done" to complete the setup.

9. Configure Authentication Policies:

   • Define the authentication policies for the IdP connection, such as allowed authentication methods, multi-factor authentication, etc.

10. Publish the Connection:

    • Ensure the connection is activated and published.

11. Test the Connection:

    • Test the SSO flow by initiating a login from GYTPOL login page.

12. Adjust as Necessary:

    • If there are issues, check logs and adjust the configuration as needed.

    • Please see the troubleshooting steps below if necessary.

These steps provide a general framework for integrating PingFederate with GYTPOL using SAML 2.0. The exact steps and configuration details may vary based on the specific requirements of your organization.

Anchor
_jb1co5orqnkl _jb1co5orqnkl

Troubleshooting and Support

Once your account manager confirms that the configuration is complete on our end, you can proceed to log in to your application. Simply click on the name of the provider on the login page to initiate the login process.

...

Anchor
_vc2p8utf84b7 _vc2p8utf84b7

Login loop

To troubleshoot, open the developer tools by either pressing F12 or right-clicking on the page and selecting "Inspect".

...

In our example, the reason for the loop may be due to the absence of the email statement. (The image example is from Okta).

...

Anchor
_ozcopqinus8 _ozcopqinus8

Groups to GYTPOL roles does not work

When automatic mapping fails, it typically indicates that the IdP did not send the groups in the SAML response.

...

1. Proceed with the login process. Then, click on the row labeled "token".

   Image RemovedImage Added

2. Navigate to the Preview tab. Copy the value of the id_token.

   

3. Visit https://jwt.io/ in your browser and paste the copied value into the provided field.

   Image Removed

...

4. In the decoded part, check if there is a "custom:groups" field in the payload.

...

4. Image Added

5. If the "custom:groups" field is missing, ensure that the IdP groups claim or statement is configured correctly.

   In Okta, this may involve double-checking the filter (explanation on Regex filtering). In AzureAD, verify if groups are configured to sAMAccountName and ensure that the claim name is correct.

Anchor
_a1tyzel8a6jb _a1tyzel8a6jb

FAQs

Anchor
_wm230rxfvyuz _wm230rxfvyuz

I've set up a role using an IdP group name, and users can successfully log in. However, when I check the role, it doesn't display any members.

Correct. Upon user login, the groups are included in a JWT sent to the backend. We then map the user's group to GYTPOL Roles internally. As a result, the user will have the permissions associated with the role but will not be listed as a member of the role.

Anchor
_jc52rkr4evx2 _jc52rkr4evx2

My IdP does not supply Metadata URLs and only allows me to download the file, what should I do?

Download the file and send it to your account manager without making any edits. We'll take care of the rest.

Anchor
_regfemps847m _regfemps847m

I want to add a user from my IdP to a role I created but I don’t see the user in the dropdown.

Correct. For GYTPOL to register the user in the database, the user needs to log in to the system first. After that, you'll be able to see them in the dropdown menu.

Anchor
_9721be8bywd2 _9721be8bywd2

Can users be created automatically in GYTPOL once we assign the application to them?

No, unfortunately we do not currently offer support for SCIM.

Anchor
_b1os91p0qbp9 _b1os91p0qbp9

I was assigned the application and was able to login, how ever I am seeing a blank screen

This situation occurs when there are roles configured in the GYTPOL application, but you haven't been assigned to any role.

Anchor
_pudjlic4mlam _pudjlic4mlam

When attempting to access the application from the application tile, you're encountering an error message indicating "Invalid samlResponse" or "relayState" from the identity provider.

We do not support IdP initiated logins, only logins initiated from GYTPOL are accepted.