TimePunch Authentication Service
TpAuthentication
The authentication object has to be send with every method whenever a user-authentication is required. This ensures that the user has the required access rights.
| Datatype | Name | Description |
|---|---|---|
| String | CustomerToken | Not used at the moment. |
| String | TpUser | TimePunch Profile of the used Principal |
| String | TpHashedPwd | Password Hash (build with MD5 Encryption) |
| String | Identity | Profile Name of the used Identity, or empty, if the identity is equal to the principal. In order to switch the identity, the principal needs administration rights. |
| String | Culture | Culture that is used for the localization. e.g. „de-DE” |
ValidatedAuthenticationDto : TpAuthentication
This class is returned at logon and contains the permissions and the filled customer token in addition to the transferred data of the TpAuthentication class.
| Datatype | Name | Description |
|---|---|---|
| List\<String> | ValidatedPermissions | Permissions of the logged on user. |
UserProfileDto
Diese Klasse enthält die Basisdaten um ein TimePunch Profil zu identifizieren.
| Datatype | Name | Description |
|---|---|---|
| Guid | Id | Unique ID of TimePunch Profile |
| String | SaveAsName | Name of the TimePunch Profile used to show the user. |
| String | LogonName | By default the logon name is identical to the used windows logon. |
| String | UserName | First name and last name of the user. |
| String | Email of the user |
UserLogonDto : UserProfileDto
This class is derived from the UserProfileDto and contains the base data and in addition a TimePunch profile to identify expanded information.
| Datatype | Name | Description |
|---|---|---|
| UserRights | Rights | Permission of the user |
| DateTime? | FirstEntry | Date/Time of the first entry, if the user has an entry, otherwise NULL |
| DateTime? | LastEntry | Date/Time of the last entry, if the user has an entry, otherwise NULL |
| Bool | IsUserProfileActive | True, if the user profile is active. |
| DateTime? | LockedUpTo | Date until that the time entries are locked. NULL, if no time entries are locked at all. |
| Bool | IsInCoverage | True, if the user profile is in coverage |
UserSearchDto : PagingContextDto
This class contains all basic data of PagingContextDto and defines a filter to search for TimePunch profiles.
| Datatype | Name | Description |
|---|---|---|
| UserFiltering | UserFiltering | Defines if the users are filtered (CurrentUser, AllUser, SelfDefined) |
| Guid[] | UserIds | If Filter is set to “SelfDefined” than the users will be filtered by the given ids. |
| String | GenericSearch | Generic search string that search for logon and/or user name. |
| Bool? | IsUserDeleted | NULL, searches for deleted and active users. True, to search only for deleted users. False, to search only for non-deleted users. |
AutoregistrationDto
This class contains information about whether automatic registration of new employees is allowed.
| Datatype | Name | Description |
|---|---|---|
| Bool | IsAutoregistrationAllowed | Defines whether the auto-registration of new staff members is allowed. |
| UserRights | DefaultUserRights | Get the user rights of new staff members |
| Bool | IsAutomaticLicensing | Defines whether new members will get a new license. But only if there are licenses still available. |