Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

ExBuilder_Authentication_MCS

Module with the authentication mobile core services.
Version 0.0.5

Summary

Client Action Description
BiometricSignature_Update Client variable to update the biometric's signature.
Change_Passcode Client action to change the passcode of a given user.
Get_HasPasscodeDefined Client action to check if the user has a passcode defined or not.
Get_UserMobileForUserDevice Client action to get the UserMobile information for a specific user and device.
Remove_User_ByUserDevice Client action to delete the UserMobile for a given user and device UUID.
Set_HasBiometricsDefined Client action to set if the user has biometrics defined.
Set_HasPasscodeDefined Client action to set if the user has a passcode defined.
Set_IsBiometricsActivated Client action to set if the user has biometrics activated.
Set_PasscodeValue Client action to set a given passcode for a given user.
StoredInformation_DeleteAll Client action to delete the local settings from the device. Used on the logout process.
User_AccountRegistration Client action to setup an account registration.
User_ChangePassword Client action to change a given user's password.
User_Check_UsernameAvailability Client action to check if the received username is available in the system.
User_ClearSessionInfo Client action to clear user data from client variables.
User_GetSessionInfo Client action to get user data from client variables.
User_GetStatus Client action to get a resume of the user account status.
User_GetUserIdByRegistrationDataUsername Client action to get the user identifier by given the registration data and username.
User_LoginWithPasscode Client action to authenticate the user in the system, by using the passcode.
If successful, returns the user information.
User_LoginWithPassword Client action to login a user by username and password.
User_RecoverUsername Client action to recover a username based on the registration data and password.
User_SetSessionInfo Client action to set user info in client variables.
User_Validate_PasswordComplexity Client action to validate a given password according to the business rules.
User_ValidatePasscode Client action to validate the passcode for a given user.
Structure Description
BiometricAuthSignature Structure used to store the users touch id configuration in keystore.
Result Result structure.
UserSessionInfo Structure to handle the user information in his session.

Client Actions

BiometricSignature_Update

Client variable to update the biometric's signature.

Inputs

UserId
Type: mandatory, Text.
Input variable with the Identifier of the current user.
Passcode
Type: mandatory, Text.
Input variable with user passcode.
BiometryType
Type: mandatory, Text.
Input variable to set the biometry type:
1 - TouchID
2 - FaceID (iOS only)
-1 - no Biometry
IsBiometricsAvailableInDevice
Type: mandatory, Text.
Input variable to indicate if biometrics are available on the current device.
IsBiometricsActiveOnApp
Type: mandatory, Text.
Input variable to indicate if biometrics are active on the app.

Outputs

Out_BiometricConfigRec
Type: BiometricAuthSignature.
Returned record with the updated biometrics information.

Change_Passcode

Client action to change the passcode of a given user.

Inputs

PasscodeValue_NewValue
Type: mandatory, Text.
Input variable with the passcode value encripted.
UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to which we'll change the passcode.

Get_HasPasscodeDefined

Client action to check if the user has a passcode defined or not.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to be checked.

Outputs

HasPasscodeDefined
Type: Boolean.
Returns true if the user has a passcode defined.

Get_UserMobileForUserDevice

Client action to get the UserMobile information for a specific user and device.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the identifier of the user from which we'll get the information.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).

Outputs

HasPasscodeDefined
Type: Boolean.
Returns true if the user has a passcode defined.
HasBiometricsDefined
Type: Boolean.
Returns true if the user defined a biometric authentication.
IsBiometricsActivated
Type: Boolean.
Returns true if the user has the biometric authentication setting activated.

Remove_User_ByUserDevice

Client action to delete the UserMobile for a given user and device UUID.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with user's identifier to delete the entry.

Set_HasBiometricsDefined

Client action to set if the user has biometrics defined.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the identifier of the user to set if it has biometrics.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).
HasBiometricsDefined_NewValue
Type: mandatory, Boolean.
Input variable indicating whether biometrics defined set or not.

Set_HasPasscodeDefined

Client action to set if the user has a passcode defined.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to set if it has a passcode defined.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).
HasPasscodeDefined_NewValue
Type: mandatory, Boolean.
Input variable indicating whether a passcode is set or not.

Set_IsBiometricsActivated

Client action to set if the user has biometrics activated.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to set if it has biometrics activated.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).
IsBiometricsActivated_NewValue
Type: mandatory, Boolean.
Input variable indicating whether biometrics is activated or not.

Set_PasscodeValue

Client action to set a given passcode for a given user.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to set the new passcode.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).
PasscodeValue_NewValue
Type: mandatory, Text.
Input variable with the value of the new passcode to be set.

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the passcode was set successfully.
UserSessionInfoRec
Type: UserSessionInfo.
Returned record with information about current user's session.

StoredInformation_DeleteAll

Client action to delete the local settings from the device. Used on the logout process.

User_AccountRegistration

Client action to setup an account registration.

Inputs

Username
Type: mandatory, Text.
Input variable with user's username.
Password
Type: mandatory, Text.
Input variable with user's password.
AccountNumber
Type: mandatory, Integer.
Input variable with user's account number.
SocialSecurityNumber
Type: mandatory, Integer.
Input variable with user's social security number.
Name
Type: mandatory, Text.
Input variable with the name of the user.
MobilePhone
Type: mandatory, Phone Number.
Input variable with user's mobile phone number.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the account registration was successfull.
UserSessionInfo
Type: UserSessionInfo.
Returned record with information about current user's session.

User_ChangePassword

Client action to change a given user's password.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user whose password will be changed.
NewPassword
Type: mandatory, Text.
Input variable with the new password to be set.

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the password was set successfully.

User_Check_UsernameAvailability

Client action to check if the received username is available in the system.

Inputs

Username
Type: mandatory, Text.
Input variable with the username to be checked.

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the username was checked successfully.
IsAvailable
Type: Boolean.
Returned value indicating if the username is available.

User_ClearSessionInfo

Client action to clear user data from client variables.

User_GetSessionInfo

Client action to get user data from client variables.

Outputs

UserSessionInfo
Type: UserSessionInfo.
Returned record with current user's session info.

User_GetStatus

Client action to get a resume of the user account status.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the identifier of the user to get status.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).

Outputs

IsNotRegistered
Type: Boolean.
Indicates if the user is not registered.
IsRegistered
Type: Boolean.
Indicates if the user is registered.
IsRegisteredDeactivated
Type: Boolean.
Indicates if the user is registered but deactivated.
IsRegisteredWithoutPasscode
Type: Boolean.
Indicates if the user is registered but without a passcode being set.
Exists
Type: Boolean.
Indicates that exists in the device.

User_GetUserIdByRegistrationDataUsername

Client action to get the user identifier by given the registration data and username.

Inputs

AccountNumber
Type: mandatory, Integer.
Input variable with user's bank account number.
SocialSecurityNumber
Type: mandatory, Integer.
Input variable with user's social security number.
Username
Type: mandatory, Text.
Input variable with user's username.

Outputs

UserId
Type: User Identifier.
Returned user identifier.
ResultStructRec
Type: Result.
Returned record with information to indicate if the user id was returned successfully.

User_LoginWithPasscode

Client action to authenticate the user in the system, by using the passcode.
If successful, returns the user information.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with the Identifier of the user to be logged in.
Passcode
Type: mandatory, Text.
Input variable with the passcode for login.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the login with passcode was successfull.
UserSessionInfoRec
Type: UserSessionInfo.
Returned record with information about current user's session.

User_LoginWithPassword

Client action to login a user by username and password.

Inputs

Username
Type: mandatory, Text.
Input variable with the username of the user to be logged in.
Password
Type: mandatory, Text.
Input variable with the password to be used for login.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the login with password was successfull.
UserSessionInfoRec
Type: UserSessionInfo.
Returned record with information about current user's session.
IsNewInDevice
Type: Boolean.
Returned record with information about current user's session.

User_RecoverUsername

Client action to recover a username based on the registration data and password.

Inputs

AccountNumber
Type: mandatory, Integer.
Input variable with user's bank account number.
SocialSecurityNumber
Type: mandatory, Integer.
Input variable with user's Social Security Number.
Password
Type: mandatory, Text.
Input variable with user's password.

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if username was recovered successfully.
UserSessionInfoRec
Type: UserSessionInfo.
Returned record with information about current user's session.

User_SetSessionInfo

Client action to set user info in client variables.

Inputs

UserSessionInfo
Type: mandatory, UserSessionInfo.
Input variable with current user's session info to be set.

User_Validate_PasswordComplexity

Client action to validate a given password according to the business rules.

Inputs

Password
Type: mandatory, Text.
Input variable with the password to be validated.
Username
Type: mandatory, Text.
Input variable with user's username.

Outputs

ResultStructRec
Type: Result.
Returned record with information to indicate if the password was validated successfully.

User_ValidatePasscode

Client action to validate the passcode for a given user.

Inputs

UserId
Type: mandatory, User Identifier.
Input variable with Identifier of the user.
DeviceId
Type: mandatory, Text.
Input variable with the mobile device's Universally Unique Identifier (UUID).
PasscodeValue
Type: mandatory, Text.
Input variable with passcode value to be validated (not encrypted).

Outputs

IsValid
Type: Boolean.
Returned value to indicate if the passcode is valid or not.

Structures

BiometricAuthSignature

Structure used to store the users touch id configuration in keystore.

Attributes

UserId
Type: User Identifier.
Represents the User Identifier.
Passcode
Type: Text.
Represents the user Passcode.
BiometryType
Type: Text.
Represents the biometrics type available on the device:
1 - TouchID
2 - FaceID (iOS only)
-1 - no Biometry
IsBiometricsActiveOnApp
Type: Text.
Flag to indicate if the biometrics are activated inside the app settings.
IsBiometricsAvailableInDevice
Type: Text.
Flag to indicate if the biometrics are available on the current device.

Result

Result structure.

Attributes

Success
Type: Boolean.
If success.
ErrorMessage
Type: Text.
Error Message if any occurs.

UserSessionInfo

Structure to handle the user information in his session.

Attributes

UserId
Type: User Identifier.
User Identifier.
DisplayName
Type: Text.
Name of the user.
Email
Type: Email.
Email
MobileNumber
Type: Text.
Mobile Number of the user
Username
Type: Text.
Username of the user.
  • Was this article helpful?