Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Enable-AdfsClient

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Enables the use of an OAuth 2.0 client registration by AD FS.

SYNTAX

Name (Default)

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

ClientId

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

InputObject

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

DESCRIPTION

The Enable-AdfsClient cmdlet enables the use of an OAuth 2.0 client registration by Active Directory Federation Services (AD FS). Use this cmdlet to enable a registered OAuth 2.0 client that is currently disabled. If AD FS receives a request for authorization from an OAuth 2.0 client that is registered with AD FS but not enabled, it will deny access to the resource.

EXAMPLES

Example 1: Enable an OAuth 2.0 client

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

This command enables the registered OAuth 2.0 client identified by the name Payroll Application.

PARAMETERS

-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

-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 enable.

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 for the registered OAuth 2.0 client to enable.

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 enable.

Type: String
Parameter Sets: Name
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

OUTPUTS

NOTES

Add-AdfsClient

Disable-AdfsClient

Get-AdfsClient

Remove-AdfsClient

Set-AdfsClient

© 2017 Microsoft