Login to the Gateway

Use the POST /Authentication/Login endpoint to send login credentials (username and password) to the API Gateway for validation. The client sends a request with the username and password in the JSON payload to the API Gateway, which then verifies the provided credentials against the stored user data. If the credentials are valid, the API Gateway returns an access token and, optionally, a refresh token for the client to use in subsequent requests. In case of invalid credentials, an appropriate error message is returned. This method ensures secure handling of sensitive user information and is a crucial part of the authentication process in the application.

SecurityApiKeyAuth

Request

header Parameters

required

string

Initialization Vector for database encryption.

Request Body schema:
application/UNENCRYPTED—DO_NOT_SEND+json

username

required

string (Username)

An string containing the user's login credential, which is either the user's primary emailAddress or primary phoneNumber.

password

required

string (Password) ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&]...

The password should meet the following requirements: 1. It should contain a minimum of 10 characters. 2. It should include at least one lower-case letter (a-z). 3. It should include at least one upper-case letter (A-Z). 4. It should include at least one numeric character (0-9). 5. It should include at least one special character from the following: ! @ # $ % ^ & * ( ) _ + - = { } | [ ] \ : ' ; < > ? , . /

Responses

200

400

Bad Request

401

Unauthorized access

post/authentication/login

Request samples

Response samples

{"userLoginDetails": {"userId": "8fffb4e6-6661-41fe-9511-20aad576c574",
"firstName": "Leonard",
"lastName": "Smith",
"timezone": "Pacific Time - 01:00 am - UTC-7",
"isMfaActive": true,
"isUserActive": true,
"isUserLocked": false,
"emailAddresses": [{"email": "bob.smith@acme.com",
"label": "work",
"primary": true
},
{"email": "buck.wild@gmail.com",
"label": "personal",
"primary": false
}
],
"phoneNumbers": [{"phoneNumber": "5555556666",
"label": "mobile",
"primary": true
},
{"phoneNumber": "5555553322",
"label": "office",
"primary": false
}
],
"userRolesByClient": [{"clientId": "987654",
"name": "Acme Co",
"userRoles": ["admin"
],
"cryptoKeys": {"deviceEncryptionKey": "63ee6fab-2e6d-4f7b-8e4b-c6643e4cf364",
"transactionEncryptionKey": "b465a1e9-42a1-4c22-a33d-f1faa80ea3b7"
}
},
{"clientId": "324234",
"name": "Pace Software",
"userRoles": ["agent",
"merchant"
],
"cryptoKeys": {"deviceEncryptionKey": "6777c9a9-2524-405b-b71f-ccbfd7cc2645",
"transactionEncryptionKey": "243df8d8-b468-4fab-b79c-e6aa8932dc63"
}
}
],
"sessionDetails": {"id": "string",
"logonTime": "2019-08-24T14:15:22Z",
"expireTime": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"browserAgent": "string"
}
},
"referenceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}