ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Web-specific functions / WEBDEV Application Server remote control functions / Types of variables
  • Properties specific to WBAdminAuth variables
  • Miscellaneous
  • Functions that use WBAdminAuth variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
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.
Remark: 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://my-server.internal/"
wbAuthLogin.User = "WWW\DATA"
wbAuthLogin.Password = "www"

WBConnections is array of WBAdminConnection = WBAdminListConnection(wbAuthLogin)

IF ErrorOccurred = True THEN
	Info(ErrorInfo)
	RETURN
END

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

Properties specific to WBAdminAuth variables

The following properties can be used to handle a variable of type WBAdminAuth:
Property nameType usedEffect
ServerAddressCharacter stringWEBDEV Application Server address, e.g. "https://www.myserver.com/".
Caution: don't forget to specify the protocol (http/https).
New in version 2024
OneTimePassword
Character 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.
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.
New in version 2024
WBAdminDeleteApplication
Deletes 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.
New in version 2024
WBAdminListApplication
Returns 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: 04/08/2024

Send a report | Local help