OneLogin SSO Setup

There are two main steps required to set up SSO using OneLogin on ImageKit:

OneLogin subscription

Although you may use a free account on OneLogin to set up and test the SSO application, having a premium OneLogin subscription is recommended for seamless role provisioning for your users. Read more here.

Create a OneLogin application

First, you need to create an application on OneLogin and generate a SAML Metadata XML file.

You may refer to the official documentation by OneLogin here or follow our brief guide below:

Log in to the OneLogin portal and open the Administration panel
Navigate to the "Applications" screen using the top navigation menu
Click the "Add App" button, then search for "SAML Custom Connector"
Choose the correct "Advanced" connector as shown below
Input a name for the application, we will use "ImageKit" for this guide

Click "Save" and wait until you are redirected to the application page.

Configure single sign-on options

On the application page, navigate to the 'Configuration' screen.

Basic SAML configuration

On this screen, we will configure various authentication parameters:

Field	Value
RelayState	`https://imagekit.io/dashboard`
Audience (EntityID)	`https://imagekit.io/saml/consume`
Recipient	`https://imagekit.io/saml/consume`
ACS (Consumer) URL Validator	`https://imagekit.io/saml/consume`
ACS (Consumer) URL	`https://imagekit.io/saml/consume`
Single Logout Url	`https://imagekit.io/logout`
SAML initiator	`OneLogin`
SAML nameID format	`Email`

Leave the rest of the values as they are.

Note: Name ID is the unique email address of the user that will be used to identify them on ImageKit.

SSO signature settings

Navigate to the "SSO" tab and change the value of "SAML Signature Algorithm" to SHA-256.

You may also note an alternate link to obtain SAML Metadata XML below it.

Attributes and claims

Now you need to specify three custom keys that ImageKit uses to authorize and provision your users:

Field Description Claim example

imagekit_id The ImageKit ID of your organization account. <your_imagekit_id>

full_name The full name of the user. e.g., Jade Smith

Field	Description	Claim example
imagekit_id	The ImageKit ID of your organization account.	`<your_imagekit_id>`
full_name	The full name of the user.	e.g., `Jade Smith`
imagekit_role	The role to assign to the user on ImageKit that would decide their access privileges. Accepted values of this key in the SAML response sent to ImageKit are: `account_administrator` `developer` `media_library_full_access` `media_library_view_only_access` `media_library_restricted_access` `finance` Read more about different ImageKit roles and their privileges here.	e.g., `developer` The final computed value of this claim must be one of the accepted role strings from the list specified alongside.

imagekit_role

The role to assign to the user on ImageKit that would decide their access privileges. Accepted values of this key in the SAML response sent to ImageKit are:

account_administrator
developer
media_library_full_access
media_library_view_only_access
media_library_restricted_access
finance

Read more about different ImageKit roles and their privileges here.

e.g., developer
The final computed value of this claim must be one of the accepted role strings from the list specified alongside.

To do this, you need to create "Custom User Fields" on OneLogin. Read the official guide here or follow the quick version below.

Navigate to "Users > Custom User Fields", and create user attributes that will be mapped and sent to ImageKit during authentication.

Back on the application page under the "Parameters" section, ensure that these fields are included correctly in your OneLogin user object.

Assign users to the SSO application on OneLogin

Assign users to the ImageKit application by going to the Users section, selecting a user, and navigating to the Applications tab on the user's details page.

Save your assignments before proceeding further.

SAML Metadata XML

Navigate to the application setup screen and use the popover menu highlighted here to download the SAML Metadata XML file.

Save it in a safe location. You will need to upload this XML file to your ImageKit account in a later step.

If you have administrator privileges on your ImageKit account, you can enable SSO for all the users in your account as follows:

Navigate to the Settings page.
Open the SAML Metadata XML file (which was downloaded previously) in a text editor of your choice.
Copy and paste the contents of the file into the Metadata XML input box.
Click on the 'Save' button.

Your users should now be able to use OneLogin SSO to log into ImageKit.

SSO users would need to initiate their very first login on ImageKit through the ImageKit app by navigating to their dashboard on OneLogin.

After their first login, they may use the ImageKit SSO login page for signing in to ImageKit directly. Read more here.

You can disable SSO login for the users on your ImageKit account by deleting the Metadata XML.

To do so, navigate to the Settings page and click on the 'Delete' button.