New-SPTrustedServiceTokenIssuer
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a trust with a SharePoint farm.
New-SPTrustedServiceTokenIssuer [-Name] <String> -Certificate <X509Certificate2> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]
New-SPTrustedServiceTokenIssuer [-Name] <String> -MetadataEndPoint <Uri> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| Name | Required | System.String | Specifies the name of the trust. The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1. | ||
| Certificate | Required | System.Security.Cryptography.X509Certificates.X509Certificate2 | The type must be a name of a valid X.509 certificate; for example, Certificate1. Specifies the X.509 certificate object from trusted authentication provider farm. | ||
| 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.
| ||
| Description | Optional | System.String | Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. |
| Parameter | Required | Type | Description | ||
| Name | Required | System.String | Specifies the name of the trust. The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1. | ||
| 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.
| ||
| 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 New-SPTrustedServiceTokenIssuer cmdlet creates 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
New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Certificate $cert
This example shows how to create a new SharePoint Farm trust using the trust certificate from a file.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: