Cryptography - Delete

Declaration

<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="text" KEYCONTAINERLEVEL="text (options)" />

Related Topics    

Description

Deletes a previously created user-level or machine-level key container.

Practical usage

See Description.

Parameters

General

Property Type Required Default Markup Description
Key container name Text Yes (Empty) KEYCONTAINERNAME="Automate" Indicates the name of the key container to identify which private or public key to use.
Key container level Text No User
  • KEYCONTAINERLEVEL="user"
  • KEYCONTAINERLEVEL="machine"
Specifies whether the key container to delete is set to User-Level or Machine-Level. The available options are:
  • User (default)
  • Machine

More details regarding Machine-Level and User-Level key containers can be found below under Additional notes.

Description

Error Causes

On Error

Additional notes

Comparing machine-level and user-level RSA key containers

User-level RSA key containers are stored with the Windows user profile for a particular user and can be used to encrypt and decrypt information for applications that run under that specific user identity. User-level RSA key containers can be useful if you want to ensure that the RSA key information is removed when the Windows user profile is removed. However, because you must be logged in with the specific user account that makes use of the user-level RSA key container in order to encrypt or decrypt protected configuration sections, they are inconvenient to use.

Machine-level RSA key containers are available to all users that can log in to a computer, by default, and are the most useful as you can use them to encrypt or decrypt protected configuration sections while logged in with an administrator account. A machine-level RSA key container can be used to protect information for a single application, all the applications on a server, or a group of applications on a server that run under the same user identity. Although machine-level RSA key containers are available to all users, they can be secured with NTFS Access Control Lists (ACLs) so that only required users can access them.

Examples

NOTE:
  • 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 deletes a user-level key container.

Copy
<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="Automate" KEYCONTAINERLEVEL="user" />

Example 2

This sample task deletes a machine-level key container.

Copy
<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="Automate" KEYCONTAINERLEVEL="machine" />