Cloudsmith Documentation Hub

Welcome to the Cloudsmith Documentation Hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Single Sign-On with JumpCloud

This guide provides step-by-step instructions on setting up JumpCloud as a SAML IdP for your Cloudsmith Organization.

Adding Cloudsmith to JumpCloud

Cloudsmith is not (yet) an integrated application in JumpCloud. You'll have to add Cloudsmith manually so you can configure SSO.

Step1

Log in as an administrator to JumpCloud, choose Applications from the sidebar and use the green + icon to add a new application:

Step2

Choose the generic SAML connector (usually first in the list, labelled SAML) and hit Configure:

Step3

On the configuration screen, enter the Display Label as "Cloudsmith", and optionally choose a colour for the application.

Step4

Next, you'll need to choose an IdP entity ID, which is just a unique string used to identify this application/connector with JumpCloud. It doesn't matter what you use, so long as it's unique within your JumpCloud account. For example purposes we use "JumpCloud-Cloudsmith":

Step5

For the next step, you'll need to generate a public and private key used to sign and secure communication between JumpCloud and Cloudsmith (if you don't already have them). JumpCloud have their own docs on exactly how to generate these keys depending on your operating system. Once generated, upload the private and public keys using the next two fields in the form:

Step6

Next, we'll fill in SP Entity ID and ACS URL with the same value. To determine the value we use the following format: https://cloudsmith.io/orgs/MY_ORG_NAME/saml/acs/, where "MY_ORG_NAME" is replaced with your organization's slug e.g. for the cloudsmith org we use https://cloudsmith.io/orgs/cloudsmith/saml/acs/:

Step7

We then need to configure the SAML Name ID attribute. We want to choose email and the appropriate emailAddress format:

Step8

Cloudsmith requires that users are identified by a first and last name, so we'll need to configure JumpCloud to send those too. Under User Attributes click add attribute and enter first/last name exactly as follows:

Step9

Almost there, we need to check the box labelled Sign Assertion:

Step10

Check the box labelled Declare redirect endpoint:

Step11

And finally, choose an appropriate IdP URL, which must be unique in your account (cloudsmith is fine, unless you have more than one connector).

Step12

Hit the green Activate button in the bottom right to complete your configuration:

Step13

Your application is now configured on JumpCloud and you can add users and groups as required using the Users tab in the sidebar:

Providing configuration to Cloudsmith

Once configured as above, you'll need to provide metadata to Cloudsmith to connect to your newly configured IdP.

At the bottom-right of the form, right beside the Activate button from the previous step you'll see an Export Metadata button. Click it and an XML file containing metadata will be downloaded.

Take this file and provide it as-is to Cloudsmith support:

All wrapped up!

The Cloudsmith application should now appear on the JumpCloud portal as normal:

Once you've received confirmation from support that your organization has been configured you can use JumpCloud to begin logging in straight away.

You'll be able to access the landing page of your organization at the following URL:
https://cloudsmith.io/orgs/YOUR_ORG_NAME/saml/login/

Where YOUR_ORG_NAME is your organization's slug/identifier (what you would normally see in the URL when accessing your organization within Cloudsmith). If you're not sure what this is, ask us.

If you have any feedback on our SAML functionality or features you wish we supported, please do let us know as it'll help inform our roadmap in future.

Updated 11 months ago


Single Sign-On with JumpCloud


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Cloudsmith: The new standard in Package Management and Software Distribution

With support for all major package formats, such as Docker. You can trust us to manage your package management for you.