Loading ...

OpenWGA 7.10 - TMLScript reference

Object:

Auth

Description

The object "Auth" collects authentication related functions of TMLScript. It provides specific authentication functionality for the domain it was retrieved from.

In WGA versions before 6.1 the Auth object was a single subobject of WGA, retrievable by "WGA.Auth", which did not provide service for a specific domain. This is still available for backward compatibility but its use is discouraged for new designs.
Retrieval Domain.auth()
Allowed in script types
  • WebTML pages and normal WebTML actions
  • Master actions
  • TMLScript tasks in jobs
  • Content type events
Properties and methods
Name Purpose
applyAccessFilter(filterId [, database]) Applies an WGAPI access filter to the current user on the current domain given database
authenticationType Returns the authentication type by which the current user was logged in
loginName Returns the authentication session object if the user is logged into this domain, null if he isn't
changeSessionPassword(newPassword) Changes the users password on the current web session
fetchCommonName(username) Fetches the common name (Display Name) for a user from the authentication backend
fetchEMail(user) Fetches the eMail address for a user from the authentication backend
findUsersAndGroups(query) Searches for users and groups on the authentication backend
getAccessFilter([database]) Returns the filter id of the currently active WGAPI access filter for the domain or database, null if there is none
login(user, password) Executes a user login in TMLScript
loginName Returns the name by which the user is logged into this domain, null if he isn't
logout() Logs a user out of a domain
lookupDN(dn) Looks up user information by a distinguished user name
module Returns the WGAPI authentication module backing this authentication
removeAccessFilter([database]) Removes a currently active WGAPI access filter
sessionCredentials Returns the credentials by which the current user is logged in to this domain
sessionUser Returns the user name by which the current user is logged in to the current domain
userGroups Returns the groups of the currently loggedin user, null if he isn't logged in.

This method is available since OpenWGA 7.9.4.
userName

Returns the distinguished name by which the user is logged into this domain, null if he isn't.

This may differ from loginName if the login is done with an alias name.
waitForUpdates(timeout) Waits until updates on an authentication content store are effective