User Account

User Authentication

Starts User Authentication

SecurityapiKeyAuth and basicAuth
Request
header Parameters
vbasoftware-client-id
required
string

Client ID

vbasoftware-client-code
required
string

Client Code

vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/user-authentication
Request samples 
Response samples 
No sample
Refresh User Tokens
Uses the Refresh Token to obtain new JWT tokens to extend the user's session.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
expired-id-token
required
string
Expired Id Token


 
refresh-token
required
string
Refresh Token


 
Responses 
200
Success


401
Unauthorized


post/user-refresh-tokens
Request samples 
Response samples 
No sample
Change Temporary Password
Changes a User's temporary password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
required
string  non-empty 
The User ID


 
newPassword
required
string  non-empty 
The User's new new password


 
session
required
string  non-empty 
The session token returned from the original login attempt that triggered the Change Temp Password flow.


 
Responses 
200
Success


401
Unauthorized


post/change-temporary-password
Request samples 
{
  • "userID": "string",
  • "newPassword": "string",
  • "session": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Forgot Password
Begin password recovery flow. Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
string or null
The User ID


 
Responses 
200
Success


401
Unauthorized


post/forgot-password
Request samples 
{
  • "userID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Confirm Forgot Password
Allows a user to enter a confirmation code to reset a forgotten password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
string or null
The User ID


 
password
string or null
The new password.


 
confirmationCode
string or null
The confirmation code received from the latest forgot password request.


 
Responses 
200
Success


401
Unauthorized


post/confirm-forgot-password
Request samples 
{
  • "userID": "string",
  • "password": "string",
  • "confirmationCode": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
User Change Password
User requests to change their password.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
accessToken
required
string  non-empty 
A valid access token that Amazon Cognito issued to the user whose password you want to change.


 
previousPassword
required
string  non-empty 
The old new password.


 
proposedPassword
required
string  non-empty 
The new password.


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/change-password
Request samples 
{
  • "accessToken": "string",
  • "previousPassword": "string",
  • "proposedPassword": "string"
}
Response samples 
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}
Admin Reset User Password
Admin request to reset a User's password. When an Administrator calls this API, the User's current password is invalidated and must be changed. If a user tries to sign in after the API is called, the User will get a PasswordResetRequired message back and should use the forgot password flow. In addition, if a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-reset-password
Request samples 
Response samples 
No sample
Admin Disable User
Admin request to disable a User.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-disable
Request samples 
Response samples 
No sample
Admin Enable User
Admin request to enable a User.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-enable
Request samples 
Response samples 
No sample
Admin Resend Confirmation Code
Resends a User a confirmation code.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/resend-confirmation-code
Request samples 
Response samples 
No sample
Admin Resend Welcome Message
Resends the invitation message to a user that already exists and resets the expiration on the user's sign-up window.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/resend-welcome-message
Request samples 
Response samples 
No sample
Lock User Account
Locks a specific user account to prevent access


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/lock
Request samples 
Response samples 
No sample
Unlock User Account
Unlocks a specific user account to grant access


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/unlock
Request samples 
Response samples 
No sample