.png)
Set-SPSecureStoreApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Sets properties of a Secure Store application.
Set-SPSecureStoreApplication -Identity <SPSecureStoreApplication> [-Administrator <SPClaim[]>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-CredentialsOwnerGroup <SPClaim[]>] [-Fields <TargetApplicationField[]>] [-TargetApplication <TargetApplication>] [-TicketRedeemer <SPClaim[]>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.Office.SecureStoreService.PowerShellCmdlet.SPSecureStoreApplication | Specifies the Secure Store application to update. | ||
| Administrator | Optional | Microsoft.SharePoint.SPClaim[] | Specifies the administrator of the Secure Store application. | ||
| 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| CredentialsOwnerGroup | Optional | Microsoft.SharePoint.SPClaim[] | Specifies the claims object for the groups that own the group credentials. | ||
| Fields | Optional | Microsoft.Office.SecureStoreService.Server.TargetApplicationField[] | Specifies the field information for the application. The default fields are username and password. | ||
| TargetApplication | Optional | Microsoft.Office.SecureStoreService.Server.TargetApplication | Specifies the target application. | ||
| TicketRedeemer | Optional | Microsoft.SharePoint.SPClaim[] | Specifies the ticket redeemer claim value. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Note: Detailed Description
The Set-SPSecureStoreApplication cmdlet sets properties of a Secure Store application.
Input Types
Return Types
------------------EXAMPLE------------------
$targetApp.FriendlyName = "Updated Contoso Target App"
Set-SPSecureStoreApplication –Identity $application –TargetApplication $targetApp
This example sets a new display name Updated Contoso Target App for the target application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
