Share via

Get-AdfsClient

  • Article

Get-AdfsClient

Retrieves registration information for an OAuth 2.0 client.

Syntax

Parameter Set: Name
Get-AdfsClient [[-Name] <String[]> ] [ <CommonParameters>]

Parameter Set: ClientId
Get-AdfsClient [-ClientId] <String[]> [ <CommonParameters>]

Parameter Set: InputObject
Get-AdfsClient [-InputObject] <AdfsClient> [ <CommonParameters>]

Detailed 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).

Parameters

-ClientId<String[]>

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<AdfsClient>

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

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

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

Examples

Example 1: Retrieve registration information for all clients

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

PS C:\> Get-AdfsClient

Example 2: Retrieve registration information by client name

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

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

Example 3: Retrieve registration information by client ID

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

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

Add-AdfsClient

Disable-AdfsClient

Enable-AdfsClient

Remove-AdfsClient

Set-AdfsClient