# Single Sign-On with PingOne

**PingOne** is a service providing single sign-on (SSO) for web and mobile applications.

As a CodeScan administrator, you can implement **Security Assertion Markup Language (SAML) 2.0 SSO** when your company uses PingOne. Users can then log in to CodeScan without providing their authentication credentials since their identity was previously validated when logging in to their PingOne session. This enables orgs to restrict login IPs via SSO.

This procedure involves the following steps:

1. Enabling Single Sign-On in CodeScan
2. Adding CodeScan as an App in PingOne
3. Entering PingOne- Identity Provider Data in CodeScan
4. Adding Attribute Mappings in PingOne
5. Testing the Single Sign-On Configuration

### Step 1: Enabling Single Sign-On in CodeScan <a href="#step-1-enabling-single-signon-in-codescan" id="step-1-enabling-single-signon-in-codescan"></a>

Before configuring SSO in PingOne, you must enable SSO in CodeScan.

1. In **CodeScan**, click on the **`Profile`** icon on the right corner of the screen and select your organization (under **`My Organizations`**).\\

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FjeunbD6zgenECyQK2p5K%2Fimage.png?alt=media&#x26;token=90a8e678-ed26-4f90-a021-107b8cee741e" alt=""><figcaption><p>Profile</p></figcaption></figure>
2. Go to **`Administration > SAML Connections`**.\\

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FiqKIdeKTJEZ2OjSXdC9F%2Fimage.png?alt=media&#x26;token=22b785dc-878c-4389-886f-5a50186badd8" alt="" width="375"><figcaption><p>SAML Connections</p></figcaption></figure>
3. Click on **`Create Connection`**.\\

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2Fw3y85vxo2ZqkZxUGAqFy%2Fimage.png?alt=media&#x26;token=1c55054b-1235-4b20-b067-72ca26047dc4" alt=""><figcaption><p>Create Connection</p></figcaption></figure>
4. In the **`Connection name`** field, enter the *identity provider* name as you want to appear (use only Latin characters without spaces and any special characters).\
   **Example-** `PingOne-SAML`
5. Enter a valid domain name of the organization in the **`Corporate domain`** field that can be authenticated in the Identity Provider. ***This property cannot be updated after SAML Connection creation.***\
   **Example**- *In case of `abc@autorabit.com`, the **corporate domain** will be `autorabit.com`*.
6. Keep the **`Enforce SSO`** checkbox unchecked for now. You can enable Enforce SSO later when your domain has been confirmed. Once enabled, only SSO authentication will be allowed for email addresses of your corporate domain.

{% hint style="info" %}
**Point to Note:**

1. Enforcing SSO affects both login and signup. Existing *Auth0* users won't be able to login.
2. Signup with email domain same as corporate domain won't be allowed.
3. If the **`Enforce SSO`** is enabled prematurely, it will prevent all **users in their organisation** from accessing CodeScan. Consider enforcing SSO only after admins have logged in to CodeScan using SSO.
4. Keep the **`SAML Connection status`** checkbox as **`Enabled`** and click on **`Create`** button.

![](https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FYE2v5XjdCJbemYlpWOS6%2Fimage.png?alt=media\&token=0745f1ae-3c89-4a3f-9039-0ee51e563193)

5. You will be able to see the **`Metadata URL`** generated for your SSO configuration. Keep the current page open while you continue to add the CodeScan app to PingOne.

<img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FrxKRvxKjySsxFYSMNywC%2Fimage.png?alt=media&#x26;token=d735612b-6209-49df-9c87-841080e64a39" alt="" data-size="original">
{% endhint %}

### Step 2: Adding CodeScan as an App in PingOne <a href="#step-2-adding-codescan-as-an-app-in-pingone" id="step-2-adding-codescan-as-an-app-in-pingone"></a>

Set up the PingOne application to provide necessary configuration information for CodeScan.

1. Log in to your [PingOne Administrator](https://admin.pingone.com/web-portal/login) account.
2. Select the **`Environment`**.
3. Go to the **`Connections`** tab and select **`Applications`** as a sub-tab.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FrmVVLmtaAaAigShM1djT%2Fimage.png?alt=media&#x26;token=61b567e1-7309-465c-a477-80a014593a5f" alt="" width="232"><figcaption></figcaption></figure>

4. Click on the![](https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FbxSXWWQuv6F0i2SE2TLb%2Fimage.png?alt=media\&token=0d5bccc2-aa48-4f21-8074-80b165d418fc)icon besides **`Applications`** to add a new app.
5. In the **`Add Application`** section,

   * Enter **`CodeScan`** for the application name and give a short description.
   * Choose **`Application Type`** as **`SAML Application`**.

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FWyVLOe1PpAx57boJfrqj%2Fimage.png?alt=media&#x26;token=ca116c67-b0c5-47fa-bcb1-41683d6b54df" alt="" width="375"><figcaption></figcaption></figure>
6. Click **`Configure`**.
7. In the **`SAML Configuration`** section, select the **`Import From URL`** option.
8. Enter the same **`Metadata URL`** which you have generated inside CodeScan.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FS08dTRMyI3xTbEFf3avE%2Fimage.png?alt=media&#x26;token=16099667-8c60-4d65-bf1c-6f6dbd1bbc9b" alt="" width="441"><figcaption></figcaption></figure>

9. Click on the **`Import`** button. The metadata should be successfully imported, and you should see the parsed metadata values.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FKwftWWBFOn25zaigt1yf%2Fimage.png?alt=media&#x26;token=c177510e-bc93-4a1f-b934-84efd7e94b22" alt="" width="430"><figcaption></figcaption></figure>

10. Click **`Save`**.

### Step 3: Entering Identity Provider Data in CodeScan <a href="#step-3-entering-identity-provider-data-in-codescan" id="step-3-entering-identity-provider-data-in-codescan"></a>

Once the application is created, you will need to enter the identity provider data from PingOne into CodeScan.

1. In **CodeScan**, on the **`SAML`** page, go to **`Actions`** and click on **`Edit`**.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FyOUlvG3muEpVTgksg0Qn%2Fimage.png?alt=media&#x26;token=b06332f7-f978-4a5e-a3f7-fdd57be0a238" alt="" width="563"><figcaption></figcaption></figure>

2. You will need to paste the *mandatory/optional* details below into CodeScan from PingOne Identity Provider.
   * **Mandatory Settings**:
     1. Provider Entity ID
     2. Sign In URL
     3. X509 Signing Certificate
     4. SAML user email attribute
     5. SAML user name attribute
   * **Optional Settings**:

     1. SAML user login attribute
     2. SAML group attribute

     <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FmT5KL3MOdIUoNSlZE2kb%2Fimage.png?alt=media&#x26;token=d79a893f-758d-45fe-a361-dd982f457fc3" alt="" width="398"><figcaption></figcaption></figure>
3. In **PingOne**, go to the **`Configuration`** tab.
4. Copy the following values:

   * **`Issuer ID`**: Copy **Issuer ID** value and paste it into **`Provider Entity Id`** inside Codescan.
   * **`Single Signon Service`**: Copy **Single Signon Service** value and paste it into **`Sign In URL`** inside Codescan.

   <figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FVJc0DTsA8qbEVB5P8wSF%2Fimage.png?alt=media&#x26;token=8789f8b9-e763-4b5c-ba26-63a05b3f12e2" alt="" width="563"><figcaption></figcaption></figure>
5. Click on the **`Edit`** icon in the top-right corner.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2Fx8eFSY0lBboNGWLJa10K%2Fimage.png?alt=media&#x26;token=61e54e13-0cfb-44ea-b29a-3e16ba9bb973" alt="" width="563"><figcaption></figcaption></figure>

6. Click on **`Download Signing Certificate`** in **X509 PEM (.crt)** format and copy the content of the file (certificate) into the **`X509 Signing Certificate`** field of Codescan SAML connection.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2Fibvvqiikh5UGjhsAR5rN%2Fimage.png?alt=media&#x26;token=871d896a-ff50-4e03-b288-171ff8976fb8" alt="" width="501"><figcaption></figcaption></figure>

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FffhwO6ekCKmk4l1vVeam%2Fimage.png?alt=media&#x26;token=deed7293-e61b-40eb-b7bf-9f8899ad5026" alt="" width="337"><figcaption></figcaption></figure>

7. Click **`Update`** on the CodeScan page.
8. The next step is to confirm your corporate domain to get the SSO working. You can confirm domain via raising a request to [Codescan Support](https://mailto:support@autorabit.com/).

### Step 4: Adding Attribute Mappings in PingOne <a href="#step-4-optional-adding-attribute-mappings-in-pingone" id="step-4-optional-adding-attribute-mappings-in-pingone"></a>

It’s necessary to sync attributes of IDP users with properties of CodeScan users.

1. In **PingOne**, go to the **`Attribute Mappings`** tab of your SAML Application and click on the **`Edit`** icon.
2. Add these attributes and map to corresponding PingOne properties:

<table data-full-width="true"><thead><tr><th>CodeScan Attribute</th><th>PingOne Attribute</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>saml_subject</td><td>User ID</td><td>Yes</td><td>User ID is a default required in PingOne</td></tr><tr><td>saml_username</td><td>Username</td><td>Yes</td><td>PingOne username will be used for newly created CodeScan users</td></tr><tr><td>saml_email</td><td>Email Address</td><td>Yes</td><td>PingOne email will be copied to user profile in CodeScan</td></tr><tr><td>saml_name</td><td>Formatted</td><td>Optional</td><td>PingOne formatted name will be copied to user profile in CodeScan</td></tr><tr><td>saml_groups</td><td>Group Names</td><td>Optional</td><td>PingOne user groups will be automatically created in CodeScan Organization, and user will be added to these groups</td></tr></tbody></table>

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2F9h02orEDchXZZjd5y906%2Fimage.png?alt=media&#x26;token=c5ec9506-541f-4888-babf-8086affcebb1" alt="" width="563"><figcaption></figcaption></figure>

3. Click **`Save`**.&#x20;
4. Enable the **`CodeScan`** app.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FJkfuZ5iiTRdwX50b9OEM%2Fimage.png?alt=media&#x26;token=e632b555-f7a1-447b-81af-53b799d5c537" alt=""><figcaption></figcaption></figure>

### Step 5: Testing the Single Sign-On Configuration <a href="#step-5-testing-the-single-signon-configuration" id="step-5-testing-the-single-signon-configuration"></a>

1. Log out of the CodeScan Console, and then log back in using the **`Log in with SAML2`** option.\
   ![](https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FYp5RMCmQh4Tb73NpvN23%2Fimage.png?alt=media\&token=ae46637c-7ec6-412d-954b-8b6cd897ae79)
2. Enter the domain name of your organization in the **`Your Company email`** field. **For example**- *autorabit.com*.
3. You should successfully redirect to the CodeScan **`Organization`** page after authentication.
