Skip to main content
Get Module License From D B

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

ownerName
string
required

Name of the module owner.

moduleName
string
required

Name of the license module.

Response

OK

OwnerName
string
ModuleName
string
ModuleDescription
string
ModuleTooltip
string
ModuleVersion
string
LicenseType
enum<string>
Available options:
Unknown,
SiteLicense,
SatelliteLicense,
UserLicense
Unrestricted
boolean
AllowedUserType
enum<string>
Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
SystemAssociate
NumberOfLicenses
integer<int32>
ExtraFlags
integer<int32>
ExtraInfo
string
SortOrder
integer<int32>
IsHidden
boolean
PrerequisiteModuleName
string
Signature
string