website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
License Types
Activations & Device Transfers
Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Changelog
License API changelog
Platform changelog
Docs powered by
Archbee
Common Scenarios
Single Sign On (SSO)

License Users SSO

7min

Please note that license users SSO (Single Sign On) is only available on Enterprise plan. It allows using Single Sign On method for license activation.

Enabling Single Sign-On (SSO) authentication facilitates the activation of user-based licenses. Currently, this functionality is accessible through the C++ and .NET/C# SDK and directly via the License API. Comprehensive instructions for the SDK implementation can be located within the SDK documentation.

To initiate SSO for your license users, the essential steps involve establishing a user pool and provider specific to the Customer Account. This configuration is pertinent to all license users within orders generated by customers associated with that particular customer account.

Implementing License User Single Sign On

Access the Customer Account view via the main platform navigation, specifically under Customers -> Customer Accounts.

Here, you can either select an existing customer account from the list or create a new one using the "Add new account" button.

Once within the customer account, navigate to the "Single Sign On" tab.

In this section, you have the option to activate SSO and gather any necessary data to ensure its seamless setup and operation.

Customer Account
Customer Account

Initial SSO tab view
Initial SSO tab view


Follow instructions to setup social identity sign in (Google) and SAML identity provider and Azure Active Directory on our Single Sign On (SSO) page.

SSO user pool and providers view
SSO user pool and providers view


Note: Please make sure at least one customer is added by creating new one or choosing from existing customers and issue at least one license that is user based for that customer.

License API Authentication

If you plan to use the License API directly to authenticate users ( instead of using SDKs ) you need to follow this flow:

Get Single Sign On Hosted UI URL

The /api/v4/sso_url endpoint will return the URL where your hosted login UI will be served. To create the correct URL you need to use customer_account_code of the customer account for which the user pool and providers have been created and the product_short_code of the product defined in LicenseSpring.

Details for this endpoint are written in the SSO URL page. Use the URL from the response to open the hosted UI through which your users can login.

Extract the id_token or code from the redirect_url and Activate the License

After successful login on the hosted UI, users will be redirected to the URL from redirect_uri field. Attached to this page URL you will receive some query parameters, of which the most important is the id_token or code if you are using authorization code grant described in more detail on the SSO URL page.

Along with the customer_account_code this field needs to be sent to the License Activation endpoint. License user needs to be assigned before that to the license which is being activated.

Updated 05 Sep 2023
Did this page help you?
PREVIOUS
Implementing Single Sign-On (SSO)
NEXT
Glossary
Docs powered by
Archbee
TABLE OF CONTENTS
Implementing License User Single Sign On
License API Authentication
Get Single Sign On Hosted UI URL
Extract the id_token or code from the redirect_url and Activate the License
Docs powered by
Archbee