See Also
Topic Last Modified: 2013-02-22
Removes an existing Open Authorization (OAuth) server. OAuth servers, also known as security token servers, issue security tokens used in server-to-server authentication and authorization. This cmdlet was introduced in Lync Server 2013.
Syntax
Remove-CsOAuthServer -Identity
<XdsGlobalRelativeIdentity> [-Confirm
[<SwitchParameter>]] [-Force <SwitchParameter>]
[-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 deletes a single OAuth server: the server with the identity "Office 365".
 Copy Code |
|
|---|---|
Remove-CsOAuthServer -Identity "Office365" |
|
Example 2
Example 2 deletes all the OAuth servers configured for use in the organization. To carry out this task, the command first calls the Get-CsOAuthServer cmdlet without any parameters in order to return all the OAuth servers. These servers are then piped to, and removed by, the Remove-CsOAuthServer cmdlet.
| Copy Code |
|
|---|---|
Get-CsOAuthServer | Remove-CsOAuthServer |
|
Detailed Description
In Lync Server 2013, server-to-server authentication (for example, the authentication that enables Lync Server 2013 and Microsoft Exchange Server 2013 to share information) is carried out using the OAuth security protocol. This type of authentication typically requires three servers: the two servers that need to communicate with one another (Server A and B) and a third-party security token server. If Servers A and B need to communicate with one another, the two servers contact the token server (also known as an OAuth server) and obtain mutually-trusted security tokens that the two servers can exchange in order to prove their identities.
If you are using an on-premises version of Lync Server 2013 and you need to communicate with another server product that fully supports the OAuth protocol (for example, Exchange 2013 or Microsoft SharePoint 2013) then you typically do not need to use a token server; that's because these server products are able to issue their own security tokens. However, if you need to communicate with another server product (including server products found on Office 365) then you will need to use a token servers. These token servers can be managed by using the CsOAuthServer cmdlets.
To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell command-line interface prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsOAuthServer"}
Lync Server Control Panel: The functions carried out by the Remove-CsOAuthServer cmdlet are not available in the Lync Server Control Panel.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity |
Unique identifier for the OAuth server to be deleted. For example: -Identity "Office 365" |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
|
Tenant |
Optional |
System.Guid |
Globally unique identifier (GUID) of the Lync Online tenant account for the OAuth server being deleted. 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 |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
The Remove-CsOAuthServer cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object.
Return Types
None. Instead, the Remove-CsOAuthServer cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object.
