 | Authenticate |
Response data from an authentication against the Licensing service.
Inheritance HierarchyNamespace: RCS.Licensing.Stdlib
Assembly: RCS.Licensing.Stdlib (in RCS.Licensing.Stdlib.dll) Version: 8.0.0+6a10b18a78f605fc5a365a56d079277e103ee6d9
SyntaxC#
public sealed class AuthenticateResponse : ResponseBase
The AuthenticateResponse type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CloudCustomerNames | A non-null array list of cloud customers the user is restricted to seeing. |
| CloudJobNames | A non-null array of cloud job names the user is retricted to seeing. |
| Comment | The user's comment. |
| Created | The user's creation time. |
| Customers | 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. |
| DashboardNames | A non-null array of Dashboard names the user is restricted to seeing. |
| DataLocation | The data location type of the user. |
| This might be useful. | |
| EntityCorporation | The user's parent entity corporation. |
| EntityDisplayName | The user's parent entity display name. |
| EntityId | The user's parent entity Id. |
| EntityInactive | The user's parent entity inactive state. |
| EntityLogo | The user's parent entity logo image url. |
| EntityName | The user's parent entity name. |
| EntitySignInLogo | The user's parent entity sign-in logo image url. |
| EntitySunset | The user's parent entity sunset date. |
| EntityType | The user's parent entity document type. |
| Filter | The user's default filter. |
| GeneratedUtc | The UTC time the response was generated (created). |
| GuestJobs | An array of special job information to support guest job limits. |
| Id | The unique database Id of the authenticated user. |
| LastLogin | The user's last login time. |
| LoginCount | The user's authentication/login count. |
| LoginMacs | Undefined. |
| LoginMax | The user's authentication/login maximum. |
| Mac | Gets the Mac value that was internally generated and used for a Login or Logoff request which adjusts licence usage counts. |
| MaxJobs | The user's maximum jobs. |
| MinVersion | Undefined. |
| ProductKey | 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. |
| Recovered | A flag indicating if a licence was recovered during authentication. |
| Roles | The user's Role characters. |
| Sequence | The user's comment. |
| Sunset | The user's optional sunset date. |
| UserName | For a user name authentication this is the login name. For other authentication types it is the commentary name for the user. |
| VartreeNames | A non-null array of Vartree names the user is restricted to seeing. |
| Version | Undefined. |
See Also