Remove-ADFSClaimDescription

  • Article

Remove-ADFSClaimDescription

Removes a claim description from the Federation Service.

Syntax

Parameter Set: Identifier
Remove-ADFSClaimDescription [-TargetClaimType] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Remove-ADFSClaimDescription [-TargetClaimDescription] <ClaimDescription> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Name
Remove-ADFSClaimDescription [-TargetName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-ADFSClaimDescription cmdlet removes a claim description from the Federation Service.

Parameters

-PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetClaimDescription<ClaimDescription>

Specifies the claim description to remove. This value is typically taken from the pipeline.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetClaimType<String>

Specifies the claim type of the claim description to remove.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-TargetName<String>

Specifies the name of the claim description to remove.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

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

  • Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription

    A class structure that represents a claim description object for the Federation Service.

Outputs

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

  • None

Notes

  • Claim descriptions are used to configure the list of claims that are available to be offered or accepted by the Federation Service.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Removes the "Role" claim description.

C:\PS>Remove-ADFSClaimDescription -TargetName "Role"

Add-ADFSClaimDescription

Get-ADFSClaimDescription

Set-ADFSClaimDescription