Export (0) Print
Expand All
Expand Minimize

Set-AuthRedirect

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-03-07

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Set-AuthRedirect cmdlet to modify the existing OAuth redirection settings for Microsoft Exchange 2010 Client Access servers in your Microsoft Exchange 2013 organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-AuthRedirect -Identity <AuthRedirectIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-TargetUrl <String>] [-WhatIf [<SwitchParameter>]]

This example sets the TargetURL value to http://cas01.contoso.com for the existing OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE.

Set-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -TargetUrl http://cas01.contoso.com

This example is the same as the first example. However, if you have only one authentication redirection object in your organization, you can use Get-AuthRedirect to pipe the Identity value to the Set-AuthRedirect cmdlet.

Get-AuthRedirect | Set-AuthRedirect -TargetUrl http://cas01.contoso.com

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "OAuth authentication redirection settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AuthRedirectIdParameter

The Identity parameter specifies the existing OAuth redirection object that you want to modify. The object name uses the syntax AuthRedirect-Bearer-<GUID>. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

TargetUrl

Optional

System.String

The TargetUrl parameter specifies the FQDN of the Exchange 2013 Client Access server that will process the Oauth request.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

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