Skip to main content
Get Current Principal

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