AUTHENTICATE |
function authenticate |
Arguments:
Name |
Required |
Type |
Default |
un |
Required |
string |
|
pw |
Required |
string |
|
admin |
Required |
boolean |
false |
accountID |
Optional |
numeric |
0 |
adminAccountID |
Optional |
numeric |
0 |
|
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Authenticates the session |
Description: |
|
|
|
AUTHENTICATEBACKOFFICE |
function authenticateBackOffice |
Arguments:
Name |
Required |
Type |
Default |
pin |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Grants or denies a user access to the Back Office admin |
Description: |
|
|
|
CLEAREXPIREDACCOUNT2FA |
function clearExpiredAccount2FA |
Arguments:
Name |
Required |
Type |
Default |
expirationMinutes |
Optional |
numeric |
10 |
approved |
Optional |
boolean |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Clears expired two-factor authentication records after a period of time |
Description: |
|
|
|
DEAUTHENTICATE |
function deauthenticate |
Arguments: | none |
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Deauthenticates the session |
Description: |
|
|
|
GENERATEHASH |
function generateHash |
Arguments:
Name |
Required |
Type |
Default |
password |
Required |
string |
|
salt |
Required |
string |
|
iterations |
Optional |
numeric |
1024 |
algorithm |
Optional |
string |
SHA-512 |
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Generates cryptographic hash |
Description: |
|
|
|
GENERATEPIN |
function generatePIN |
Arguments: | none |
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Generates a one-time code for two-factor authentication |
Description: |
|
|
|
GENERATESALT |
function generateSalt |
Arguments:
Name |
Required |
Type |
Default |
size |
Optional |
numeric |
16 |
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Generates cryptographic salts |
Description: |
|
|
|
GETACCOUNT2FA |
function getAccount2FA |
Arguments:
Name |
Required |
Type |
Default |
accountID |
Optional |
numeric |
|
pin |
Optional |
string |
|
ipAddress |
Optional |
string |
|
approved |
Optional |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Gets one or more pending verifications for the Back Office |
Description: |
|
|
|
GETACCOUNTAPPROVED |
function getAccountApproved |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETACCOUNTDATA |
function getAccountData |
Arguments:
Name |
Required |
Type |
Default |
id |
Optional |
numeric |
|
un |
Optional |
string |
|
uuid |
Optional |
string |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
package |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Retrieves account data |
Description: |
|
|
|
GETACCOUNTID |
function getAccountID |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETACCOUNTISGENERICPRIMARY |
function getAccountIsGenericPrimary |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETACCOUNTPENDING |
function getAccountPending |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETACCOUNTUSERNAME |
function getAccountUserName |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETACCOUNTUUID |
function getAccountUUID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADMINACCOUNTID |
function getAdminAccountID |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADMINCONTACTID |
function getAdminContactID |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETBASICSIGNUP |
function getBasicSignup |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCONTACTBOARDMEMBER |
function getContactBoardMember |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCONTACTCONNECTSGROUP |
function getContactConnectsGroup |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCONTACTID |
function getContactID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCONTACTMANAGER |
function getContactManager |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCONTACTUUID |
function getContactUUID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETEVENTREGISTRATIONLOCKOUT |
function getEventRegistrationLockout |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETFIRSTNAME |
function getFirstName |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETFUNDMATCHLOCKOUT |
function getFundMatchLockout |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETGENERALRELEASESIGNED |
function getGeneralReleaseSigned |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETLASTNAME |
function getLastName |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETONSITEIP |
function getOnsiteIP |
Arguments: | none |
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Retrieves one or more on-site IP addresses |
Description: |
|
|
|
GETORGANIZATIONID |
function getOrganizationID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONISADMIN |
function getOrganizationIsAdmin |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONSTATUSID |
function getOrganizationStatusID |
Arguments: | none |
ReturnType: |
numeric
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONTYPEID |
function getOrganizationTypeID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONTYPENAME |
function getOrganizationTypeName |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONTYPEUUID |
function getOrganizationTypeUUID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETORGANIZATIONUUID |
function getOrganizationUUID |
Arguments: | none |
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETPERMISSIONS |
function getPermissions |
Arguments: | none |
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETVARIABLE |
function getVariable |
Arguments:
Name |
Required |
Type |
Default |
name |
Required |
string |
|
|
ReturnType: |
any
|
Roles: |
|
Access: |
private |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Retrieves the specified variable |
Description: |
|
|
|
HAS |
function has |
Arguments:
Name |
Required |
Type |
Default |
accessType |
Optional |
string |
|
accessModifier |
Optional |
string |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Determines authentication access |
Description: |
|
|
|
INIT |
function init |
Arguments:
Name |
Required |
Type |
Default |
datasource |
Required |
string |
|
reportingDatasource |
Required |
string |
|
|
ReturnType: |
authentication
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Initializes the session authentication object |
Description: |
|
|
|
MASKEMAIL |
function maskEmail |
Arguments:
Name |
Required |
Type |
Default |
email |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Only shows the first few characters of an email, and the domain |
Description: |
|
|
|
REFRESH |
function refresh |
Arguments: | none |
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Refreshes the session |
Description: |
|
|
|
SENDVERIFICATIONEMAIL2FA |
function sendVerificationEmail2FA |
Arguments:
Name |
Required |
Type |
Default |
pin |
Required |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Sends a verification email containing a randomly generated code |
Description: |
|
|
|
SETACCOUNT2FA |
function setAccount2FA |
Arguments:
Name |
Required |
Type |
Default |
data |
Required |
struct |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Adds a new pending verification, or updates an existing one |
Description: |
|
|
|
SETAUTHENTICATIONDATA |
function setAuthenticationData |
Arguments:
Name |
Required |
Type |
Default |
data |
Required |
query |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
package |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Sets account authentication data |
Description: |
|
|
|