License API
Single Sign-On URL
7min
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) docid\ mt2ygm6cjzh2bumu gfww 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 type ssourlrequestparams = { product string, customer account code string, response type? 'code' | 'token' | undefined } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "product" { "type" "string" }, "customer account code" { "type" "string" }, "response type" { "type" "string", "enum" \["code", "token"] } }, "required" \["product", "customer account code"], "additionalproperties" false } response body type ssourlresponsebody = { url string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "url" { "type" "string" } }, "required" \["url"], "additionalproperties" false } 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 { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } 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 }