Security - Authenticate
Declaration
<AMSECURITY ACTIVITY="authenticate" PASSWORD="text (encrypted)" USERNAME="text"/>
Description
Stops task execution at a specific line until the user authenticates himself/herself in the specified manner.
Practical usage
Ideal when particular tasks contain sensitive information and should only be run by specific users or when specific proper authentication is provided.
Parameters
Authenticate
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Must pass a standard Windows logon | --- | No | --- | --- | If
selected, a valid user name and password normally used to log onto
the system must be entered for the task to continue.
During runtime, an Authentication
Required dialog appears, prompting the user to enter
the required username/password. This parameter is selected by default. NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
| Must enter this password | Text | No | (Empty) | PASSWORD="text (encrypted)" | If selected, specify a password that the user is required to enter before the task can continue. In Visual Mode, simply enter the password in the provided field. This value is automatically encrypted during entry. |
| This user must be logged on | Text | No | (Empty) | USERNAME="John.Doe" | If enabled, specifies a valid Windows user name. The user specified must be logged on for the task to continue. |
Examples
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Example 1
This sample task authenticates by way of password entry. At runtime, a valid password must be entered in the provided dialog.
<AMSECURITY ACTIVITY="authenticate" PASSWORD="AM5WsHAugrOfa3s2ynIQ==aME" />Example 2
The sample task authenticates by way of specified user. A specific user must be logged on in order to pass authentication.
<AMSECURITY ACTIVITY="authenticate" USERNAME="AUSHER" />