Remove-VBOFederatedAuthenticationAuthority

Short Description

Removes external authentication providers.

Syntax

Remove-VBOFederatedAuthenticationAuthority -Authority <VBOFederatedAuthenticationAuthority> [<CommonParameters>]

Detailed Description

This cmdlet removes an external authentication provider.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Authority

Specifies an external authentication provider. The cmdlet will remove this external authentication provider.

Accepts the VBOFederatedAuthenticationAuthority object.

To get this object, run the Get-VBOFederatedAuthenticationAuthority cmdlet.

True

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

None.

Example

Removing External Authentication Provider

This example shows how to remove an external authentication provider.

$authority = Get-VBOFederatedAuthenticationAuthority -Id 8657138e-ca49-4f91-XXXX-a17818eb818e

Remove-VBOFederatedAuthenticationAuthority -Authority $authority

Perform the following steps:

  1. Run the Get-VBOFederatedAuthenticationAuthority cmdlet. Specify the Id parameter value. Save the result to the $authority variable.
  2. Run the Remove-VBOFederatedAuthenticationAuthority cmdlet. Set the $authority variable as the Authority parameter value.

Related Commands

Get-VBOFederatedAuthenticationAuthority