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

Get-AdfsClient

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Retrieves registration information for an OAuth 2.0 client.

SYNTAX

Name (Default)

Get-AdfsClient [[-Name] <String[]>] [<CommonParameters>]

ClientId

Get-AdfsClient [-ClientId] <String[]> [<CommonParameters>]

InputObject

Get-AdfsClient [-InputObject] <AdfsClient> [<CommonParameters>]

DESCRIPTION

The Get-AdfsClient cmdlet retrieves registration information for an OAuth 2.0 client that was previously registered with Active Directory Federation Services (AD FS).

EXAMPLES

Example 1: Retrieve registration information for all clients

PS C:\> Get-AdfsClient



RedirectUri : {ms-app://windows.immersivecontrolpanel/}
Name        : Device Registration Client
Description : Client for the Device Registration Service
ClientId    : dd762716-544d-4aeb-a526-687b73838a22
BuiltIn     : True
Enabled     : True
ClientType  : Public

RedirectUri : {https://168f3ee4-63fc-4723-a61a-6473f6cb515c/redir}
Name        : Windows Server Work Folders Client
Description : Client for syncing user files to a Work Folders sync share
ClientId    : 168f3ee4-63fc-4723-a61a-6473f6cb515c
BuiltIn     : True
Enabled     : True
ClientType  : Public

This command retrieves registration information for all OAuth 2.0 clients currently registered withAD FS.

Example 2: Retrieve registration information by client name

PS C:\> Get-AdfsClient -Name "Device Registration Client"



RedirectUri : {ms-app://windows.immersivecontrolpanel/}
Name        : Device Registration Client
Description : Client for the Device Registration Service
ClientId    : dd762716-544d-4aeb-a526-687b73838a22
BuiltIn     : True
Enabled     : True
ClientType  : Public

This command retrieves registration information for the OAuth 2.0 client named Device Registration Client.

Example 3: Retrieve registration information by client ID

PS C:\> Get-AdfsClient -ClientId "dd762716-544d-4aeb-a526-687b73838a22"



RedirectUri : {ms-app://windows.immersivecontrolpanel/}
Name        : Device Registration Client
Description : Client for the Device Registration Service
ClientId    : dd762716-544d-4aeb-a526-687b73838a22
BuiltIn     : True
Enabled     : True
ClientType  : Public

This command retrieves registration information for the OAuth 2.0 client specified by the client identifier dd762716-544d-4aeb-a526-687b73838a22.

PARAMETERS

-ClientId

Specifies an array of client identifiers for the OAuth 2.0 client for which to retrieve registration information.

Type: String[]
Parameter Sets: ClientId
Aliases: 

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

-InputObject

Specifies an object of type AdfsClient that represents an OAuth 2.0 client for which to retrieve registration information.

Type: AdfsClient
Parameter Sets: InputObject
Aliases: 

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

-Name

Specifies the name of the OAuth 2.0 client for which to retrieve registration information.

Type: String[]
Parameter Sets: Name
Aliases: 

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

System.Object

NOTES

Add-AdfsClient

Disable-AdfsClient

Enable-AdfsClient

Remove-AdfsClient

Set-AdfsClient

© 2017 Microsoft