Remove-ADFSClaimDescription
Removes a claim description from the Federation Service.
Syntax
Remove-ADFSClaimDescription
[-TargetName] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-ADFSClaimDescription
[-TargetClaimType] <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-ADFSClaimDescription
[-TargetClaimDescription] <ClaimDescription>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-ADFSClaimDescription cmdlet removes a claim description from the Federation Service.
Examples
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Remove-ADFSClaimDescription -TargetName "Role"
Description
Removes the "Role" claim description.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetClaimDescription
Specifies the claim description to remove. This value is typically taken from the pipeline.
Type: | ClaimDescription |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetClaimType
Specifies the claim type of the claim description to remove.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TargetName
Specifies the name of the claim description to remove.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription
A class structure that represents a claim description object for the Federation Service.
Outputs
None
Notes
- Claim descriptions are used to configure the list of claims that are available to be offered or accepted by the Federation Service.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for