.png)
Set-SPTrustedServiceTokenIssuer
Published: May 12, 2010
Updates a trust with the farm.
Set-SPTrustedServiceTokenIssuer [-Identity] <SPTrustedServiceTokenIssuerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Description <String>]
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.SharePoint.PowerShell.SPTrustedServiceTokenIssuerPipeBind |
Specifies the trusted service token issuer to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. |
|
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. 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. |
|
Certificate |
Optional |
System.Security.Cryptography.X509Certificates.X509Certificate2 |
Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. |
|
Description |
Optional |
System.String |
Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. |
Detailed Description
The Set-SPTrustedServiceTokenIssuer cmdlet updates a trust with a SharePoint farm. If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.
Input Types
Return Types
------------------EXAMPLE 1------------------
$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Set – SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" – ImportTrustCertificate $cert
This example updates a SharePoint Farm trust using the trust certificate from a file.
------------------EXAMPLE 2------------------
Set – SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" –FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml"
This example updates a SharePoint farm trust using the trust certificate from the federation metadata endpoint URL.
Change History
| Date | Description | Reason |
|---|---|---|
|
May 12, 2010 |
Initial publication |
|
