Set-CsOAuthConfiguration

Modifies the Open Authorization (OAuth) configuration settings currently in use in the organization. OAuth is a standard protocol used for server-to-server authentication and authorization. This cmdlet was introduced in Lync Server 2013.

Syntax

Set-CsOAuthConfiguration
   [[-Identity] <XdsIdentity>]
   [-Confirm]
   [-ExchangeAutodiscoverAllowedDomains <String>]
   [-ExchangeAutodiscoverUrl <String>]
   [-Force]
   [-Realm <String>]
   [-ServiceName <String>]
   [-Tenant <Guid>]
   [-WhatIf]
   [-ClientAuthorizationOAuthServerIdentity <String>]
   [<CommonParameters>]
Set-CsOAuthConfiguration
   [-Confirm]
   [-Force]
   [-Instance <PSObject>]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]
Set-CsOAuthConfiguration
   [[-Identity] <Object>]
   [-AdditionalAudienceUrls <Object>]
   [-AlternateAudienceUrl <Object>]
   [-BypassDualWrite <Object>]
   [-ClientAdalAuthOverride <Object>]
   [-ClientAuthorizationOAuthServerIdentity <Object>]
   [-Confirm]
   [-ExchangeAutodiscoverAllowedDomains <Object>]
   [-ExchangeAutodiscoverUrl <Object>]
   [-Force]
   [-Instance <Object>]
   [-Realm <Object>]
   [-ServiceName <Object>]
   [-Tenant <Object>]
   [-WhatIf]
   [-AsJob]
   [<CommonParameters>]

Description

In Skype for Business Server, server-to-server authentication (for example, the authentication that enables Skype for Business Server and Exchange to share information) is carried out using the OAuth security protocol. OAuth is always on in Skype for Business Server; there is no need (or even any way) to enable or disable the protocol. However, if Skype for Business Server needs to communicate with other server products you might need to modify your OAuth configuration settings; for example, you might need to specify the autodiscover URL for the Office 365 version of Exchange, and you might need to specify your Realm name. These settings can only be managed by using the CsOAuthConfiguration cmdlets; options for managing OAuth settings are not available in the Skype for Business Server Control Panel.

Note that, for the on-premises version of Skype for Business Server, you can have only a single, global collection of OAuth settings: you cannot not create additional collections of OAuth settings nor can you delete the global collection. Each Skype for Business Online tenant is also limited to a single collection of OAuth configuration settings.

Skype for Business Server Control Panel: The functions carried out by the Set-CsOAuthConfiguration cmdlet are not available in the Skype for Business Server Control Panel.

Examples

-------------------------- Example 1 --------------------------

Set-CsOAuthConfiguration -Identity global -Realm "contoso.com"

The command shown in Example 1 modifies the global collection of OAuth configuration settings. In this example, the Realm property is set to "contoso.com".

Optional Parameters

-AdditionalAudienceUrls

{{Fill AdditionalAudienceUrls Description}}

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-AlternateAudienceUrl

{{Fill AlternateAudienceUrl Description}}

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-AsJob

{{Fill AsJob Description}}

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-BypassDualWrite

{{Fill BypassDualWrite Description}}

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ClientAdalAuthOverride

{{Fill ClientAdalAuthOverride Description}}

Type:Object
Parameter Sets:NoOverride, Allowed, Disallowed
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ClientAuthorizationOAuthServerIdentity

URI of the OAuth server used for client authentication.

Type:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2015
-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-ExchangeAutodiscoverAllowedDomains

Collection of domains that autodiscover requests can be redirected to. For example:

-ExchangeAutodiscoverAllowedDomains "*.contoso.com","*.fabrikam.com"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-ExchangeAutodiscoverUrl

URL for the autodiscovery service used by the Office 365 version of Microsoft Exchange Server.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-Force

Suppresses the display of any non-fatal error message that might occur when running the command.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-Identity

Unique Identity of the OAuth configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Set-CsOAuthConfiguration cmdlet. You can, however, use the following syntax to reference the global settings:

-Identity global

Type:XdsIdentity
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-Instance

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-Realm

Server-to-server security container. By default, Skype for Business Server uses your default SIP domain as its OAuth realm.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-ServiceName

Globally unique identifier (GUID) assigned to the OAuth service.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-Tenant

Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the OAuth configuration settings are being modified. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return the tenant ID for each of your tenants by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015
-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Online, Skype for Business Server 2015

Inputs

The Set-CsOAuthConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object.

Outputs

None. Instead, the Set-CsOAuthConfiguration cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object.