Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Set-SPTrustedSecurityTokenIssuer

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets the trusted token issuer.

Set-SPTrustedSecurityTokenIssuer [-Identity] <SPTrustedSecurityTokenServicePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-IsTrustBroker <SwitchParameter>] [-MetadataEndPoint <Uri>] [-RegisteredIssuerName <String>] [-WhatIf [<SwitchParameter>]]
Set-SPTrustedSecurityTokenIssuer [-Identity] <SPTrustedSecurityTokenServicePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-IsTrustBroker <SwitchParameter>] [-RegisteredIssuerName <String>] [-WhatIf [<SwitchParameter>]]

Parameters

1

Parameter

Required

Type

Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPTrustedSecurityTokenServicePipeBind

Specifies the id of the SPTrustedSecurityTokenIssuer object to be set.

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.

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

Description

Optional

System.String

Specifies the description of the issuer.

IsTrustBroker

Optional

System.Management.Automation.SwitchParameter

Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server 2010 or Exchange Server 2007 or Lync).

MetadataEndPoint

Optional

System.Uri

Specifies the URI for the metadata endpoint of the issuer.

RegisteredIssuerName

Optional

System.String

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

2

Parameter

Required

Type

Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPTrustedSecurityTokenServicePipeBind

Specifies the id of the SPTrustedSecurityTokenIssuer object to be set.

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.

Certificate

Optional

System.Security.Cryptography.X509Certificates.X509Certificate2

Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer.

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

Description

Optional

System.String

Specifies the description of the issuer.

IsTrustBroker

Optional

System.Management.Automation.SwitchParameter

Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server 2010 or Exchange Server 2007 or Lync).

RegisteredIssuerName

Optional

System.String

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

Detailed Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

Use the Set-SPTrustedSecurityTokenIssuer cmdlet to set the trusted token issuer.

To set the certificate successfully, all of the required parameters must be specified.

Input Types

Return Types

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

$a=Get-SPTrustedSecurityTokenIssuer
Set-SPTrustedSecurityTokenIssuer –Identity $a -MetadataEndpoint https://<webappurl/>/_layouts/15/metadata/json/1/

This example sets the metadata endpoint of the url for the self-issue.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.