AuthServerUserSettings Model

The different types of user information that can be requested from AuthServer

Nullable
id : string

Always included - User's ID

Nullable
shortName : string

User's short name for general usage - eg Josh, Bob, Craig

Nullable
fullName : string

User's full name for identification purposes - eg Barack Hussein Obama

Nullable
email : string

User's email address

Nullable
image : string

Base 64 encoded 128x128 PNG user image (if uploaded) or a default placeholder if not uploaded

Nullable
organisationName : string

Name of the organisation logged into

Nullable
organisationCode : string

Code of the organisation logged into

Nullable
organisationActive : bool

Is the Organisation active?

Nullable
organisationROSBaseURI : string

base uri of the remote order service (ROS) instance assigned o the organisation logged into (can be null)

Nullable
locale : string

User specified preferred Locale

Nullable
defaultCurrencyCode : string

User specified preferred ISO 4217 default currency code

Nullable
scopesEncoded : string

A space delimeted string of scopes

Nullable
permissionsEncoded : string

An flattened list of permissions where each permissions is encoded as 4 hex characters
(3 characters for POSCorePublic.SecurityAuthServerPermissionIDs and 1 character for AuthServerPermissionActions)

Nullable
isSuperUser : bool

Is this user listed as a system wide super user?

Example
{
  "id": "string value",
  "shortName": "string value",
  "fullName": "string value",
  "email": "string value",
  "image": "string value",
  "organisationName": "string value",
  "organisationCode": "string value",
  "organisationActive": true,
  "organisationROSBaseURI": "string value",
  "locale": "string value",
  "defaultCurrencyCode": "string value",
  "scopesEncoded": "string value",
  "permissionsEncoded": "string value",
  "isSuperUser": true
}