Client Config

Create SSOConfig

Creates a new SSOConfig

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
ssoConfig_ID
required
string [ 1 .. 32 ] characters

A unique identifier for each SSO configuration setting. This is the primary key of the table.

auth_URL
string or null <= 512 characters

The authorization URL for the initial authentication step in the SSO process.

client_ID
string or null <= 256 characters

The client ID issued by the identity provider.

client_Secret
string or null <= 256 characters

The client secret issued by the identity provider.

description
string or null

A detailed description of the SSO configuration.

display
string or null <= 64 characters

The display name for the SSO configuration. This value is displayed to the user on the login screen.

provider_Name
string or null <= 128 characters

The name of the SSO provider (e.g., Active Directory, Google, Okta, Auth0).

redirect_URL
string or null <= 512 characters

The URL to which the identity provider will redirect the user after authentication.

ssO_Enable
required
boolean

A flag indicating whether the SSO configuration is enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.

scopes
string or null <= 512 characters

A list of scopes or permissions requested from the identity provider.

token_URL
string or null <= 512 characters

The token URL used to exchange an authorization code for an access token.

Responses
200

Success

401

Unauthorized

post/sso-configs
Request samples
{
  • "ssoConfig_ID": "string",
  • "auth_URL": "string",
  • "client_ID": "string",
  • "client_Secret": "string",
  • "description": "string",
  • "display": "string",
  • "provider_Name": "string",
  • "redirect_URL": "string",
  • "ssO_Enable": true,
  • "scopes": "string",
  • "token_URL": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SSOConfig

Lists all SSOConfig

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/sso-configs
Request samples 
Response samples 
No sample
Get SSOConfig
Gets SSOConfig


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SSOConfig_ID
required
string
SSOConfig ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/sso-configs/{SSOConfig_ID}
Request samples 
Response samples 
No sample
Update SSOConfig
Updates a specific SSOConfig.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SSOConfig_ID
required
string
SSOConfig ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
ssoConfig_ID
required
string  [ 1 .. 32 ] characters 
A unique identifier for each SSO configuration setting. This is the primary key of the table.


 
auth_URL
string or null  <= 512 characters 
The authorization URL for the initial authentication step in the SSO process.


 
client_ID
string or null  <= 256 characters 
The client ID issued by the identity provider.


 
client_Secret
string or null  <= 256 characters 
The client secret issued by the identity provider.


 
description
string or null
A detailed description of the SSO configuration.


 
display
string or null  <= 64 characters 
The display name for the SSO configuration.  This value is displayed to the user on the login screen.


 
provider_Name
string or null  <= 128 characters 
The name of the SSO provider (e.g., Active Directory, Google, Okta, Auth0).


 
redirect_URL
string or null  <= 512 characters 
The URL to which the identity provider will redirect the user after authentication.


 
ssO_Enable
required
boolean
A flag indicating whether the SSO configuration is enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
scopes
string or null  <= 512 characters 
A list of scopes or permissions requested from the identity provider.


 
token_URL
string or null  <= 512 characters 
The token URL used to exchange an authorization code for an access token.


 
Responses 
200
Success


401
Unauthorized


put/sso-configs/{SSOConfig_ID}
Request samples 
{
  • "ssoConfig_ID": "string",
  • "auth_URL": "string",
  • "client_ID": "string",
  • "client_Secret": "string",
  • "description": "string",
  • "display": "string",
  • "provider_Name": "string",
  • "redirect_URL": "string",
  • "ssO_Enable": true,
  • "scopes": "string",
  • "token_URL": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SSOConfig
Deletes an SSOConfig


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SSOConfig_ID
required
string
SSOConfig ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/sso-configs/{SSOConfig_ID}
Request samples 
Create or Update Batch SSOConfig
Create or Update multiple SSOConfig at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
Request Body schema: 
required
 Array 
ssoConfig_ID
required
string  [ 1 .. 32 ] characters 
A unique identifier for each SSO configuration setting. This is the primary key of the table.


 
auth_URL
string or null  <= 512 characters 
The authorization URL for the initial authentication step in the SSO process.


 
client_ID
string or null  <= 256 characters 
The client ID issued by the identity provider.


 
client_Secret
string or null  <= 256 characters 
The client secret issued by the identity provider.


 
description
string or null
A detailed description of the SSO configuration.


 
display
string or null  <= 64 characters 
The display name for the SSO configuration.  This value is displayed to the user on the login screen.


 
provider_Name
string or null  <= 128 characters 
The name of the SSO provider (e.g., Active Directory, Google, Okta, Auth0).


 
redirect_URL
string or null  <= 512 characters 
The URL to which the identity provider will redirect the user after authentication.


 
ssO_Enable
required
boolean
A flag indicating whether the SSO configuration is enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
scopes
string or null  <= 512 characters 
A list of scopes or permissions requested from the identity provider.


 
token_URL
string or null  <= 512 characters 
The token URL used to exchange an authorization code for an access token.


 
Responses 
207
Success


401
Unauthorized


put/sso-configs-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Client Environments
Lists the client environments that are available for the given client id and client code.


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


 
vbasoftware-client-code
required
string
Client Code


 
Responses 
200
Success


401
Unauthorized


get/client-environments
Request samples 
Response samples 
No sample
Get Application Information
Returns the latest application information including version, file details, release notes, and release date in JSON format.


SecurityapiKeyAuth 
Request 
path Parameters
environment
required
string
environment


 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
Responses 
200
Success


401
Unauthorized


get/app-info/{environment}
Request samples 
Response samples 
No sample
SSO Callback
This endpoint is the callback URL for the Single Sign-On (SSO) process. It receives an authorization code from the identity provider (e.g., Cognito) and exchanges it for an access token. The access token is then used to authenticate the user in the application.


SecurityapiKeyAuth 
Request 
query Parameters
state
required
string
base64 encoded state


 
code
required
string
Authorization Code


 
Responses 
200
Success


401
Unauthorized


get/sso-callback
Request samples 
Response samples 
No sample