Remove-AdfsClient
Remove-AdfsClient
Deletes registration information for an OAuth 2.0 client that is currently registered with AD FS.
構文
Parameter Set: Name
Remove-AdfsClient [-TargetName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ClientId
Remove-AdfsClient [-TargetClientId] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject
Remove-AdfsClient [-TargetClient] <AdfsClient> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Remove-AdfsClient cmdlet deletes registration information for an OAuth 2.0 client that is currently registered withActive Directory フェデレーション サービス (AD FS). After you delete the registration information for the OAuth 2.0 client, AD FS no longer issues authorization codes or access tokens to that OAuth 2.0 client.
パラメーター
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-TargetClient<AdfsClient>
Specifies the registered OAuth 2.0 client to delete.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-TargetClientId<String>
Specifies the client identifier for the registered OAuth 2.0 client to delete.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-TargetName<String>
Specifies the name of the registered OAuth 2.0 client to delete.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドレットを実行する前に、ユーザーに確認を求めます。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- System.Object
例
Example 1: Delete registration information for an OAuth client
This command deletes registration information for the OAuth 2.0 client that is identified by the name Payroll Application.
PS C:\> Remove-AdfsClient -TargetName "Payroll Application"