Skip to main content
Get Current Principal

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.

Response

OK

Summary description for SoPrincipalCarrier.

UserType
enum<string>

Type of user

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
SystemAssociate
Associate
string

Associate name (e.g. logon name) for the user

AssociateId
integer<int32>

AssociateId for the user.

IsPerson
boolean

Is this associate a person, and not a resource?

PersonId
integer<int32>

Associate's person id

CountryId
integer<int32>

Country id for the user.

HomeCountryId
integer<int32>

Country id for the user's home country. This is the default country id when creating new items.

ContactId
integer<int32>

Company of the associate's person

GroupId
integer<int32>

Associate's group_idx

BusinessId
integer<int32>

BusinessIdx for the company that the user belongs to.

CategoryId
integer<int32>

CategoryIdx of the company that the user belongs to.

ContactOwner
integer<int32>

Owner (AssocaiteId) of the company that the user belongs to.

RoleId
integer<int32>

Id of the users role

RoleName
string

Name of the users role

RoleDescription
string

Descrtiption (e.g. tooltip) for the users role

RoleType
enum<string>

Type of user.

Available options:
Employee,
ExternalUser,
Anonymous,
System
Licenses
object[]

License granted to the site and user.

FullName
string

The Person full name if the associate is a person. Use IsPerson to check

EMailAddress
string

The Person e-mail address if the associate is a person. Use IsPerson to check

FunctionRights
string[]

Functional rights for the user. This array is sorted so a lookup can be performed using {M:System.Array.BinarySearch(System.Array,System.Int32,System.Int32,System.Object)}.

EjUserId
integer<int32>

Primary key in eJournal's old user table.

EjAccessLevel
integer<int32>

eJournal user access level

EjUserStatus
enum<string>

eJournal user status

Available options:
StatusNone,
StatusNormal,
StatusNotAvailable,
StatusDeleted,
StatusReadOnly,
StatusSpm,
StatusSystem
ProvidedCredentials
object[]

The credentials used for authenticating this user.

SecondaryGroups
integer<int32>[]

Secondary user groups

DatabaseContextIdentifier
string

Name of the database context

UserName
string

UserName on associatetable. Same as SuperId from Online