GET User/currentPrincipal

• 4 minutes to read
 • 4 minutes to read 
GET /api/v1/User/currentPrincipal

Gets the currently logged in user's information, even in Online.

Does not call an agent - just returns the current session info.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: SoPrincipalCarrier

Property Name Type Description
UserType string Type of user
Associate string Associate name (e.g. logon name) for the user
AssociateId int32 AssociateId for the user.
IsPerson bool Is this associate a person, and not a resource?
PersonId int32 Associate's person id
CountryId int32 Country id for the user.
HomeCountryId int32 Country id for the user's home country. This is the default country id when creating new items.
ContactId int32 Company of the associate's person
GroupId int32 Associate's group_idx
BusinessId int32 BusinessIdx for the company that the user belongs to.
CategoryId int32 CategoryIdx of the company that the user belongs to.
ContactOwner int32 Owner (AssocaiteId) of the company that the user belongs to.
RoleId int32 Id of the users role
RoleName string Name of the users role
RoleDescription string Descrtiption (e.g. tooltip) for the users role
RoleType string Type of user.
Licenses array 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 array 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 int32 Primary key in eJournal's old user table.
EjAccessLevel int32 eJournal user access level
EjUserStatus string eJournal user status
ProvidedCredentials array The credentials used for authenticating this user.
SecondaryGroups array Secondary user groups
DatabaseContextIdentifier string Name of the database context
UserName string UserName on associatetable. Same as SuperId from Online

Sample request

GET /api/v1/User/currentPrincipal
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "UserType": "AnonymousAssociate",
  "Associate": "ullam",
  "AssociateId": 358,
  "IsPerson": false,
  "PersonId": 192,
  "CountryId": 203,
  "HomeCountryId": 660,
  "ContactId": 792,
  "GroupId": 707,
  "BusinessId": 990,
  "CategoryId": 725,
  "ContactOwner": 531,
  "RoleId": 581,
  "RoleName": "Abshire LLC",
  "RoleDescription": "Reverse-engineered scalable help-desk",
  "RoleType": "Anonymous",
  "Licenses": [
    {
      "OwnerId": 496,
      "OwnerName": "Marvin-Berge",
      "OwnerDescription": "Function-based leading edge projection",
      "ModuleId": 191,
      "Name": "Wisozk-Jerde",
      "Description": "Focused attitude-oriented ability",
      "Version": "ut",
      "LicenseType": "SatelliteLicense",
      "ExtraFlags": 848,
      "ExtraInfo": "voluptate",
      "SortOrder": 974,
      "LicenseNumber": 818,
      "IsHidden": false,
      "IsUnrestricted": false,
      "ExpiryDate": "2005-10-14T17:54:08.7574316+02:00",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 872
        }
      }
    }
  ],
  "FullName": "Jacinto Rath",
  "EMailAddress": "velit",
  "FunctionRights": [
    "quae",
    "aspernatur"
  ],
  "EjUserId": 466,
  "EjAccessLevel": 706,
  "EjUserStatus": "StatusDeleted",
  "ProvidedCredentials": [
    {
      "Type": "aut",
      "SearchName": "Dooley-Price",
      "DisplayName": "Powlowski-Howe",
      "CredentialId": 377
    },
    {
      "Type": "aut",
      "SearchName": "Dooley-Price",
      "DisplayName": "Powlowski-Howe",
      "CredentialId": 377
    }
  ],
  "SecondaryGroups": [
    80,
    709
  ],
  "DatabaseContextIdentifier": "quis",
  "UserName": "Cassin LLC"
}