Class AuthenticateRequest
Used to Authenticate a user and receive the token for subsequent requests.
Properties
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| RequestId | string | Unique identifier used to identify the request. Used when associating the request to the response. |
| RequestDate | dateTime | DateTime request was made. Request timeout is 1 minute. |
| Credentials | JackHenry.Eps.Mobile.CredentialsBase | REQUIRED. Generic object representing different security token validation options to authenticate to the EPS system. |
| DeviceTracking | DeviceTracking | REQUIRED. The device information used to help identify problems. |
CredentialsBase
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| PhoneKey | string | REQUIRED. The unique id for the phone. A GUID created by the app vendor at first time use and stored in long term storage on the device which is intended to be unique to the device and application. Limit of 100 characters. Printable characters only. |
DeviceTracking
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| AppBundleId | string | REQUIRED. This is the application id used by the different platform stores. ex. eps.mobile.remotedeposit |
| AppVersion | string | REQUIRED. This is the application version string. |
| DeviceModel | string | REQUIRED. This is the device's model number. |
| DeviceSystemName | string | REQUIRED. This is the device OS the application is running on. ex. ios |
| DeviceSystemVersion | string | REQUIRED. This is the device's OS version. |
| Vendor | string | REQUIRED. The company name of the application/vendor. This is not the FI's name unless the FI did their own application. |
Examples
{
"__type":"AuthenticateRequest:#JackHenry.Eps.Mobile.RDC",
"Credentials":
"DeviceTracking":
{
"__type":"DeviceTracking:#JackHenry.Eps.Mobile.RDC",
"AppBundleId":"String Content",
"AppVersion":"String Content",
"DeviceSystemName":"String Content",
"DeviceSystemVersion":"String Content",
"DeviceModel":"String Content",
"Vendor":"String Content",
}
}
Methods
Validate(IValidatorContext)
Declaration
public void Validate(IValidatorContext context)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| JHA.EPS.SharedService.Common.Validator.IValidatorContext | context |
Exceptions
| TYPE | DESCRIPTION |
|---|---|
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Credentials must pass authentication |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Token must be valid |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | User must be enabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | User must be authorized |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Terminal must be enabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Domain must be enabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Mobile Location must exist |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | If MFA, must pass MFA authentication |