Get-AdfsClient
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ClientId
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InputObject
Specifies an object of type AdfsClient that represents an OAuth 2.0 client for which to retrieve registration information.
Parameter properties
| Type: | AdfsClient |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the OAuth 2.0 client for which to retrieve registration information.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
String objects are received by the ClientId and Name parameters.
AdfsClient
AdfsClient objects are received by the InputObject parameter.
Outputs
AdfsClient
Returns one or more AdfsClient objects that represent the Adfs Clients for the Federation Service.