Assisted Sign-On Properties, Methods, and Events

The Assisted Sign-On component lets Studio store items such as user name and password in an encrypted format for use in an automation. The following tables describe the properties, methods, and events for the Assisted Sign-On component.

Properties

Property

Description

This

A reference to this object.

Methods

Method

Description

Parameters

Return Type

AddApplication

Use 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

 

AddApplication
(overload)

Use this method to add an application to the Enter Credentials window. You must enter and application key,  domain, user name, password, and group

applicationKey, domain, userName, password, group

 

ApplicationExists

Use this method to determine if an application exists. The system returns True if the application exists.

applicationKey

Boolean

ClearPasswords

Use this method to clear all passwords.

none

 

Decrypt

Use this method to decrypt a string.

encryptedData

 

Encrypt

Use this method to encrypt a string. The encrypted information persists during this Runtime/Agile Desktop session.

data

string

GetAllApplications

Use this method to get a list of all of the applications associated with the object.  

list

string

GetCredentials

Use 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

 

GetEncryptedCredentials

Use this method to get the encrypted credentials from the application you specify.

applicationKey, domain, userName, password

Boolean

GetEncryptedDomain

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

applicationKey

 

GetEncryptedPassword

Use this method to get the encrypted  password from the application you specify.

applicationKey

 

GetEncryptedUserName

Use this method to get the encrypted user  name from the application you specify.

applicationKey

 

GetLastSaveTime

Use this method to return  the time of day the credentials were last saved for the application you specify

none

string

GetLoadedApplications

Use this method to return  a list of the loaded applications

none

string

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.

applicationKey

string

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.

applicationKey

String

IsPasswordSet

Indicates if the user has ever set the password for a given application.

applicationKey

Boolean

PerformLogin

Use this method to perform a login.

applicationKey

Boolean

RemoveApplication

Use this method to remove an application listed on the Enter Credentials window.

applicationKey

 

SaveAsoFile

Use this method to save the encrypted database file (ASO.db), which contains the credentials, in your local application data folder.

none

 

SetCredentials

Use this method to set the user name, password, and domain name for the application you specify.

applicationKey,  
domain, userName, password

void

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

 

SetPassword

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

applicationKey, password

 

SetUserName

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

applicationKey, userName

 

ShowCredentialDialog

Use this method to display the Enter Credentials dialog showing each application one at a time.

credentialsModified

Boolean

ShowCredentialDialog
(overload)

Use this method to display the Enter Credentials dialog showing all applications.

applicationKey, credentialsModified

Boolean

 

Events

There are no events for Assisted Sign-On.

 

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 18 June 2020

© 2016 - 2020 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label