Skip to content

Latest commit

 

History

History
172 lines (126 loc) · 3.98 KB

Disable-AdfsClient.md

File metadata and controls

172 lines (126 loc) · 3.98 KB
Raw
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
Microsoft.IdentityServer.Management.dll-Help.xml
ADFS
12/20/2016
2.0.0
Disable-AdfsClient

Disable-AdfsClient

SYNOPSIS

Disables an OAuth 2.0 client that is currently registered with AD FS.

SYNTAX

Name (Default)

Disable-AdfsClient [[-TargetName] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

ClientId

Disable-AdfsClient [-TargetClientId] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Disable-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Disable-AdfsClient cmdlet disables an OAuth 2.0 client that is currently registered with Active Directory Federation Services (AD FS). After you disable the client, AD FS no longer authorizes requests to access resources from that OAuth 2.0 client.

EXAMPLES

Example 1: Disable an OAuth 2.0 client

PS C:\> Disable-AdfsClient -TargetName "Payroll Application"

This command disables the OAuth 2.0 client that is currently registered with AD FS.

PARAMETERS

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetClient

Specifies the registered OAuth 2.0 client to disable.

Type: AdfsClient
Parameter Sets: InputObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TargetClientId

Specifies the client identifier of the registered OAuth 2.0 client to disable.

Type: String
Parameter Sets: ClientId
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetName

Specifies the name of the registered OAuth 2.0 client to disable.

Type: String
Parameter Sets: Name
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.IdentityServer.Management.Resources.AdfsClient

AdfsClient objects are received by the TargetClient parameter.

System.String

String objects are received by the TargetClientId and TargetName parameters.

OUTPUTS

Microsoft.IdentityServer.Management.Resources.AdfsClient

Returns the disabled AdfsClient object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

NOTES

RELATED LINKS

Add-AdfsClient

Enable-AdfsClient

Get-AdfsClient

Remove-AdfsClient

Set-AdfsClient