License API
Single Sign-On URL

7min
Returns the Single Sign-On Url for license user authorization
GET
Request
Query Parameters
product
required
String
Product short code
customer_account_code
required
String
The customer account code to which SSO provider is configured 
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
Curl
Node.js
JS
Python
Ruby
curl --location --request GET '/api/v4/sso_url?product=string&customer_account_code=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
curl --location --request GET '/api/v4/sso_url?product=string&customer_account_code=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'
Responses
200
{
    "url": "https://q3h6u2gqmd5ftz8ara29u2b0xgdjzh.auth.us-east-2.amazoncognito.com/login?response_type=token&client_id=3a0c2l4b6qjmp7cv3ucmhv1uo4&redirect_uri=https://saas.licensespring.com/sso/"
}
{
    "url": "https://q3h6u2gqmd5ftz8ara29u2b0xgdjzh.auth.us-east-2.amazoncognito.com/login?response_type=token&client_id=3a0c2l4b6qjmp7cv3ucmhv1uo4&redirect_uri=https://saas.licensespring.com/sso/"
}
﻿
Authorization method
By default, authorization method used for SSO is Implicit grant which attaches user pool tokens ( id_token, access_token, expires_in and token_type ) to the redirect_uri once the user is verified. The id_token then can be used when Single Sign On server as authentification for license user in Activate License (Online Method)﻿﻿
If you do not wan't to expose user tokens or the redirect uri is too long for your use case, you can use Authorization code grant method where instead of id_token the code query param is attached to the redirect_uri and this code is sent instead of id_token on request body when doing license activation. To enable Authorization code grant attach the optional response_type=code query param to this endpoint. Example:/api/v4/sso_url/?customer_account_code=test&product=test&response_type=code
Schema
Request Query Parameters
TypeScript
JSON
type SSOURLRequestParams = {
  product: string,
  customer_account_code: string,
}
type SSOURLRequestParams = {
  product: string,
  customer_account_code: string,
}
﻿
Response Body
TypeScript
JSON
type SSOURLResponseBody = {
  url: string
}
type SSOURLResponseBody = {
  url: string
}
﻿
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
List of exceptions
unknown_product (400): Provided product was not found
missing_headers (400): Some headers are missing
authorization_missing_params (400): Some parameters are missing in the authorization: { params }
﻿
Updated 17 Jan 2025
Did this page help you?
List License Users for Customer
Management API