Skip to main content

Assisted Sign-on Manager Methods

Suggest edit Updated on November 10, 2021

With Assisted Sign-on (ASO) Manager components, you can store items such as user name and password in an encrypted format for use in an automation.

ASOManager app management

MethodDescriptionParametersReturn type
Add applicationUse this method to add an application to the Enter Credentials window. You must enter and application key, domain, user name, and password. applicationKey, domain, userName, password
ApplicationExistsUse this method to determine if an application exists. The system returns True if the application exists. applicationKeyBoolean
GetAllApplicationsUse this method to get a list of all of the applications associated with the object. liststring
GetLoadedApplicationsUse this method to return a list of the loaded applications nonestring
RemoveApplicationsUse this method to remove applications listed on the Enter Credentials window. applicationKey

ASOManager dialogs

MethodDescriptionParametersReturn type
ShowCredentialDialogUse this method to display the Enter Credentials dialog showing each application one at a time. credentialsModifiedBoolean
ShowCredentialDialogByCategory

ASOManager file management

MethodDescriptionParametersReturn type
DeleteASOFileUse this method to delete the encrypted database file (ASO.db), which contains the credentials, in your local application data folder.
SaveASOFileUse this method to save the encrypted database file (ASO.db), which contains the credentials, in your local application data folder. none

ASOManager get/set

MethodDescriptionParametersReturn type
DecryptUse this method to decrypt a string. encryptedData
EncryptUse this method to encrypt a string. The encrypted information persists during this Runtime/Agile Desktop session. datastring
ClearPasswordsUse this method to clear all passwords. none
GetCredentialsUse this method to get the user name, password, and domain name from the application you specify. The system returns True as the result if the parameters are successfully retrieved. applicationKey, domain, userName, password, Boolean
GetDatePasswordChanged

Use this method to return the last date the password changed in the ASO.db file for the application you specify.

Note: passwordSet returns False if the user has never entered a password for the application.

applicationKey, passwordSet Boolean
GetDaysSincePasswordChanged

Use this method to get the number of complete days since the last password change for a given application

For instance, if the password was changed on February 7 and today's date is February 17, this method returns 10.

applicationKey
GetDomain

Use this method to get the domain from the application you specify.

The domain contains additional information, more than a user ID and password, that is required to sign on. This could be a domain name, a Personal Identification Number (PIN), a region, and so on.

applicationKey
GetEncryptedCredentialsUse this method to get the encrypted credentials from the application you specify. applicationKey, domain, userName, password Boolean
GetEncryptedDomainUse this method to get the encrypted domain name from the application you specify. applicationKey
GetEncryptedPasswordUse this method to get the encrypted password from the application you specify. applicationKey
GetEncryptedUserNameUse this method to get the encrypted user name from the application you specify. applicationKey
GetLastSaveTimeUse this method to return the time of day the credentials were last saved for the application you specify nonestring
GetPassword

Use this method to return the password for the application you specify.

You will typically use this method to work with the Text adapter.

applicationKeystring
GetUserName

Use this method to return the user name for the application you specify.

You will typically use this method to work with the Text adapter.

applicationKeystring
IsPasswordSetIndicates if the user has ever set the password for a given application. applicationKeyBoolean
SetCredentialsUse this method to set the user name, password, and domain name for the application you specify. applicationKey, domain, userName, passwordvoid
PerformLoginUse this method to perform a login. applicationKeyBoolean
SetDomain

Use this method to set the domain for the application you specify.

The domain contains additional information, more than a user ID and password, that is required to sign on. This could be a domain name, a Personal Identification Number (PIN), a region, and so on.

applicationKey, domain
SetPasswordUse this method to set the password for the application you specify. applicationKey, password
SetUserNameUse this method to set the user name for the application you specify. applicationKey, userName
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us