gpwUser (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / User Groupware functions

Properties specific to gpwUser variables
Functions that use the gpwUser type:

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwUser (Variable type)

In french: gpwUtilisateur

The gpwUser type is used to describe and modify the characteristics of a user of WEBDEV or WINDEV User Groupware.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Valeurs du nouvel utilisateur
clUtilisateur is gpwUser
clUtilisateur.Email = SAI_Email
clUtilisateur.Login = SAI_Login
clUtilisateur.Password = SAI_MotPasse
clUtilisateur.LastName = SAI_Nom
clUtilisateur.FirstName = SAI_Prenom
clUtilisateur.PhoneNumber = SAI_Telephone

// Ajout de l'utilisateur
IF gpwAddUser(clUtilisateur) = False THEN
	Info("Impossible d'ajouter l'utilisateur.")
	RETURN
END
// Activation de l'utilisateur
SWITCH gpwActivateUser(clUtilisateur.Login)
	// Pour une activation par email
	CASE gpwActivationByEmail
		PopupDisplay(POPUP_ValidationInscription)
	// Pour une activation immédiate
	CASE gpwActivationImmediate
		// Connecte directement l'utilisateur
		gpwConnectUser(clUtilisateur.Login, clUtilisateur.Password)
		// Affiche la popup de confirmation
		PopupDisplay(POPUP_ConfirmationInscription)
	OTHER CASE
		Info("Impossible d'activer l'utilisateur.")
END

Properties

Properties specific to gpwUser variables

The following properties can be used to define the characteristics of gpwUser variables:

Name	Type used	Effect

AccessRights	Integer constant	User access rights: gpwRightAddApplication: Right to add an application to the Private Store. gpwDroitAucun: No addition rights.
Email	Character string	User's email address.
Enabled	Boolean	True if user is enabled, False otherwise.
FirstName	Character string	User's first name.
IDExternal	Character string	Identifier of the user in a database external to the groupware. This property can be used for example to link the user of the User Groupware of the User file of the application that uses the groupware by referencing its identifier.
Login	Character string	Username.
Name	Character string	User's last name.
Password	Character string or Secret string	User password. This password is not retuned when gpwGetUserInfo is used to get the user information. 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. New in version 2025 Secret strings are not available for this parameter in Android/Android widget applications.
PasswordToEnter	Boolean	True if users must enter their password the first time they log in, False otherwise.
Phone	Character string	User's phone number.
Supervisor	Boolean	True if the user is a supervisor, False otherwise.
TOTPKey	Character string	TOTP key linked to the user for the two-factor authentication. Note: This property is only taken into account for User Groupware in WDBaaS mode and the Private Store.
TrustList	Buffer	If the two-factor authentication is turned on, the user can indicate that the current computer is a trusted computer. This property lists all user-defined trusted devices, computers and browsers. Note: In the user profile interface provided by User Groupware, you can delete trusted machines.
TwoFactorAuthentication	Integer	Two-factor authentication management mode: 0: Inactive two-factor authentication. Two-factor authentication is turned off for the user and is not required. 1: Active two-factor authentication. Two-factor authentication is turned on for the user. 2: Activate two-factor authentication. Two-factor authentication is required but it is turned off. Note: This property is only taken into account for User Groupware in WDBaaS mode and the Private Store.

Remarks

Functions that use the gpwUser type:


gpwAddUser	Adds a user to the User Groupware database.
gpwFindUser	Retrieves the characteristics of a user of the User Groupware.
gpwGetUserInfo	Retrieves information about the current user (application that uses the User Groupware).
gpwModifyUser	Modifies a user in the User Groupware database.