Export (0) Print
Expand All

New-SPSecureStoreApplication

 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Creates a new Secure Store application.

New-SPSecureStoreApplication -Fields <TargetApplicationField[]> -ServiceContext <SPServiceContextPipeBind> -TargetApplication <TargetApplication> [-Administrator <SPClaim[]>] [-AssignmentCollection <SPAssignmentCollection>] [-CredentialsOwnerGroup <SPClaim[]>] [-TicketRedeemer <SPClaim[]>]

The New-SPSecureStoreApplication cmdlet creates a new Secure Store application.

 

Parameter Required Type Description

ServiceContext

Required

Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind

Specifies the service context for the target application.

TargetApplication

Required

Microsoft.Office.SecureStoreService.Server.TargetApplication

Specifies information about the target application. For example, the TargetApplication object includes data values for application name, display name, contact info, enable ticketing flag, and URL address to set the credential. The schema for the TargetApplication object is defined in the ISecureSToreProviderExtended interface that exposes the target application metadata.

Administrator

Optional

Microsoft.SharePoint.SPClaim[]

Specifies the administrator of the new 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.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

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.

TicketRedeemer

Optional

Microsoft.SharePoint.SPClaim[]

Specifies the ticket redeemer claim value.

------------------EXAMPLE------------------

$usernameField = New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false

$passwordField = New-SPSecureStoreApplicationField -Name "Password" -Type WindowsPassword -Masked:$true

$fields = $usernameField,$passwordField


$userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName

$contosoTargetApp = New-SPSecureStoreTargetApplication -Name "ContosoTargetApplication" -FriendlyName "Contoso Target Application" -ApplicationType Group

New-SPSecureStoreApplication -ServiceContext http://contoso -TargetApplication $contosoTargetApp -Fields $fields -Administrator $claimUser

This example creates a new group target application ContosoTargetApplication, and then a new application for that target application. This new application has two fields; UserName of type WindowsUserName, and Password of type WindowsPassword. The user with identity janedoe on the CONTOSO domain is set as the target application administrator.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft