Generate VUC Single Sign-On (SSO) token

Generate VUC Single Sign-On (SSO) token

Summary
This document explains how to generate a VUC Single Sign-On token via the VSM4 API and use it to sign in to VUC.

Prerequisites

  • VSM4 Professional license is required.

Endpoint

POST https://{DOMAIN}/vsm4/api/OwnerClientsSubAccount/CreateVucSsoToken

Authentication

Authorization: ****** Content-Type: application/json

Request Body

Provide either ClientId or ClientLogin, plus TokenTTL (minutes).

{ "ClientId": 0, "ClientLogin": "", "TokenTTL": 1 }

Field Details

Field

Type

Required

Notes

Field

Type

Required

Notes

ClientId

integer

Conditional

Provide either ClientId or ClientLogin

ClientLogin

string

Conditional

Provide either ClientLogin or ClientId

TokenTTL

integer

Yes

Token time-to-live in minutes

cURL Example

curl --location --request POST 'https://{DOMAIN}/vsm4/api/OwnerClientsSubAccount/CreateVucSsoToken' \ --header 'Content-Type: application/json' \ --header 'Authorization: ******' \ --data '{ "ClientId": 10, "ClientLogin": "", "TokenTTL": 1 }'

Successful Response

{ "token": "TOKEN", "ttl": 1 }

Using the Token (VUC SSO)

Open:

https://{DOMAIN}/vuc/SingleSignOn?token=TOKEN

Outcomes

  • 200 OK → User is redirected to VUC (SSO succeeded).

  • 401 Unauthorized → Response body contains one of: TokenMissing, TokenExpired, TokenUsed, TokenCorrupted, ERROR.

Error Reference

  • TokenMissing - token not provided.

  • TokenExpired - token TTL elapsed.

  • TokenUsed - token already consumed.

  • TokenCorrupted - token invalid/corrupted.

  • ERROR - generic/server-side error.

Security Notes

  • Treat the returned token as a sensitive credential.

  • Keep TokenTTL minimal to reduce risk.

Extra Examples

Generate by login

curl --location --request POST 'https://{DOMAIN}/vsm4/api/OwnerClientsSubAccount/CreateVucSsoToken' \ --header 'Content-Type: application/json' \ --header 'Authorization: ******' \ --data '{ "ClientId": 0, "ClientLogin": "client.login", "TokenTTL": 5 }'

Redirect flow (pseudo)

GET https://{DOMAIN}/vuc/SingleSignOn?token=TOKEN → if 200: follow redirect to VUC → if 401: inspect body for reason (see Error Reference)