Authentication

Log out user

Terminates the current user's session and logs them out of the system.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Logout successful

401

Unauthorized

post/logout
Request samples 
Forcefully terminate a user session
Ends the session of the specified user.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userId
required
string
User ID to kick


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
User session terminated successfully


401
Unauthorized


post/kick/{userId}
Request samples 
Forcefully terminate the longest active user session
Ends the session of the user who has been logged in the longest, forcing them to log in again.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Longest active user session terminated successfully


401
Unauthorized


post/kick
Request samples 
Get Password Policy
Retrieves the current Cognito password policy.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/password-policy
Request samples 
Response samples 
No sample
Update Password Policy
Updates the Cognito password policy.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
minimumLength
integer <int32>   [ 6 .. 99 ] 
Password minimum length (6-99). Default 8.


 
requireNumbers
boolean
Require at least one number.


 
requireSymbols
boolean
 
requireUppercase
boolean
Require at least one uppercase letter.


 
requireLowercase
boolean
Require at least one lowercase letter.


 
temporaryPasswordValidityDays
integer <int32>   [ 0 .. 365 ] 
Temporary passwords set by administrators expire in X days (0-365). Default 7.


 
Responses 
200
Success


401
Unauthorized


put/password-policy
Request samples 
{
  • "minimumLength": 6,
  • "requireNumbers": true,
  • "requireSymbols": true,
  • "requireUppercase": true,
  • "requireLowercase": true,
  • "temporaryPasswordValidityDays": 365
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}