Click or drag to resize

AuthenticateResponse Properties

The AuthenticateResponse type exposes the following members.

Properties
 NameDescription
Public propertyCloudCustomerNames A non-null array list of cloud customers the user is restricted to seeing.
Public propertyCloudJobNames A non-null array of cloud job names the user is retricted to seeing.
Public propertyComment The user's comment.
Public propertyCreated The user's creation time.
Public propertyCustomers An non-null array of distinct Licensing Customers (not cloud customers) that the authenticated user has access to. This information does not come from the User's licencing record, it is calculated by connections (joins) in the organisation tree.
Public propertyDashboardNames A non-null array of Dashboard names the user is restricted to seeing.
Public propertyDataLocation The data location type of the user.
Public propertyEmail This might be useful.
Public propertyEntityCorporation The user's parent entity corporation.
Public propertyEntityDisplayName The user's parent entity display name.
Public propertyEntityId The user's parent entity Id.
Public propertyEntityInactive The user's parent entity inactive state.
Public propertyEntityLogo The user's parent entity logo image url.
Public propertyEntityName The user's parent entity name.
Public propertyEntitySignInLogo The user's parent entity sign-in logo image url.
Public propertyEntitySunset The user's parent entity sunset date.
Public propertyEntityType The user's parent entity document type.
Public propertyFilter The user's default filter.
Public propertyGeneratedUtc The UTC time the response was generated (created).
Public propertyGuestJobs An array of special job information to support guest job limits.
Public propertyId The unique database Id of the authenticated user.
Public propertyLastLogin The user's last login time.
Public propertyLoginCount The user's authentication/login count.
Public propertyLoginMacs Undefined.
Public propertyLoginMax The user's authentication/login maximum.
Public propertyMac Gets the Mac value that was internally generated and used for a Login or Logoff request which adjusts licence usage counts.
Public propertyMaxJobs The user's maximum jobs.
Public propertyMinVersion Undefined.
Public propertyProductKey The product key string that is assigned to the licensing service. Every deployment of an RCS compatible licensing service must have a product key assigned to it by Red Centre Software. The key is used by certain Red Centre apps to verify that they are being used in a licensed environment. The Carbon engine validates the key during job opens.
Public propertyRecovered A flag indicating if a licence was recovered during authentication.
Public propertyRoles The user's Role characters.
Public propertySequence The user's comment.
Public propertySunset The user's optional sunset date.
Public propertyUserName For a user name authentication this is the login name. For other authentication types it is the commentary name for the user.
Public propertyVartreeNames A non-null array of Vartree names the user is restricted to seeing.
Public propertyVersion Undefined.
Top
See Also