ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Web-specific functions / WEBDEV Application Server administration functions / Types of variables
  • Properties specific to WBAdminAuth variables
  • Miscellaneous
  • Functions that use WBAdminAuth variables
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
The WBAdminAuth type allows you to define all the advanced characteristics of the API used to remotely manage a WEBDEV Application Server. You can define and change the characteristics of this API using different WLanguage properties.
Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Example
wbAuthLogin is WBAdminAuth
wbAuthLogin.ServerAddress = "https://mon-serveur.interne/"
wbAuthLogin.User = "WWW\DATA"
wbAuthLogin.Password = "www"

ConnexionsWB is array of WBAdminConnection = WBAdminListConnection(wbAuthLogin)

IF ErrorOccurred = True THEN
	Info(ErrorInfo)
	RETURN
END

FOR i = 1 _TO_ ConnexionsWB.Count  
	Trace(ConnexionsWB[i].Site)
	Trace(DateTimeToString(ConnexionsWB[i].DateTimeStartConnection))
	Trace(DurationToString(ConnexionsWB[i].IdleTime, durationCenti))
END
Properties

Properties specific to WBAdminAuth variables

The following properties can be used to manipulate a variable of type WBAdminAuth:
Property nameType usedEffect
ServerAddressCharacter stringWEBDEV Application Server address, e.g. "https://www.myserver.com/".
Please note: it is necessary to specify the address with the protocol used (http/https)..
OneTimePasswordCharacter stringOne-time code used if 2-factor authentication has been enabled via the WEBDEV administration site for a given account.
Remarks:
  • Two-factor authentication requires a unique code to verify the user's identity. This code can be received by email or via an Authenticator app.
  • If the different WBAdminxxx functions encounter an error identified with code "2", you need to specify the OneTimePassword property. To do so, the application must include a window (or page) where the user can enter the code received. This code can then be assigned to the OneTimePassword property.
PasswordCharacter stringPassword associated with the user.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.
PortIntegerNumber of the port used (e.g., 443 by default for https).
UserCharacter stringName of the user who will manage the WEBDEV Application Server. This user must be a WEBDEV administrator.
Remarks

Miscellaneous

  • The API used is a REST web service.
  • There is no active session and the connection is authenticated at each API call.

Functions that use WBAdminAuth variables

WBAdminCreateAccountCreates a WEBDEV account on a WEBDEV Application Server.
WBAdminDeleteAccountDeletes a WEBDEV account from a WEBDEV Application Server.
WBAdminDeleteApplicationDeletes an application from a WEBDEV Application Server.
WBAdminDisconnectDeletes a connection from a WEBDEV Application Server.
WBAdminListAccountReturns the list of WEBDEV accounts on a WEBDEV Application Server.
WBAdminListApplicationReturns the list of applications on a WEBDEV Application Server, for a given account and a given type.
WBAdminListConnectionReturns the list of current connections on a WEBDEV Application Server.
WBAdminUpdateAccountUpdates the characteristics of a WEBDEV account in a WEBDEV Application Server.
Minimum version required
  • Version 28
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/16/2025

Send a report | Local help