Add-ADFSClaimDescription
Adds a claim description to the Federation Service.
Add-ADFSClaimDescription
-Name <String>
-ClaimType <String>
[-IsAccepted <Boolean>]
[-IsOffered <Boolean>]
[-IsRequired <Boolean>]
[-Notes <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]The Add-ADFSClaimDescription cmdlet adds a claim description to the Federation Service.
C:\PS>Add-ADFSClaimDescription -name "Role" -ClaimType "https://fabrikam.com/role"Description
Adds a new claim description for a custom Role claim.
Specifies the claim type URN or URI of the claim. All claim descriptions must include a valid URN or URI.
| Type: | String |
| Position: | Named |
| Default value: | False |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
Specifies that the claim should be published in federation metadata as a claim that the Federation Service accepts.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies that the claim should be published in federation metadata as a claim that the Federation Service offers.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies that the claim should be published in federation metadata as a claim that the Federation Service requires.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the friendly name of this claim.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies any notes for this claim description.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
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 |
None
None
- You can use claim descriptions to configure the list of claims that are available to be offered or accepted by AD FS 2.0.