Update-SPSecureStoreMasterKey
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Changes the master key of a Secure Store Service application.
Update-SPSecureStoreMasterKey -Passphrase <String> -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind> [-AssignmentCollection <SPAssignmentCollection>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Passphrase | Required | System.String | Specifies the passphrase that is used for the Secure Store database. The passphrase that you enter is not stored. Make sure that you write down the passphrase and store it in a secure location. The passphrase will be required to add new Secure Store service servers. | ||
| ServiceApplicationProxy | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind | Specifies the proxy of the Secure Store service application that contains the master key to update. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Reencrypt | Optional | System.Management.Automation.SwitchParameter | Specifies that the database for the Secure Store service application is re-encrypted. This synchronizes the master key in all servers that run an instance of the Secure Store application. |
Detailed Description
The Update-SPSecureStoreApplicationServerKey cmdlet changes the master key of a Secure Store Service application.
Updating the master key is required when:
-
A new instance of a service application is created and the database for the Secure Store service application is new or empty.
-
The master key or passphrase has been compromised.
-
Security guidelines require that the passphrase or key be replaced.
Input Types
Return Types
------------------EXAMPLE------------------
$newPassPhrase = "abcDEF123!"
Update-SPSecureStoreMasterKey –ServiceApplicationProxy $contosoProxy –Passphrase $newPassPhrase
This example creates a new master key for the given service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: