Set-SPTrustedSecurityTokenIssuer

Sets the trusted token issuer.

Syntax

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

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 (http://go.microsoft.com/fwlink/?LinkID=187810).

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

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

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

C:\PS>$a=Get-SPTrustedSecurityTokenIssuer

C:\PS>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.

Required Parameters

-Identity

Specifies the id of the SPTrustedSecurityTokenIssuer object to be set.

Type:SPTrustedSecurityTokenServicePipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AssignmentCollection

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Certificate

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

Type:X509Certificate2
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Description

Specifies the description of the issuer.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-IsTrustBroker

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-MetadataEndPoint

Specifies the URI for the metadata endpoint of the issuer.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-RegisteredIssuerName
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016