Add-ADFSClaimDescription
Add-ADFSClaimDescription
Adds a claim description to the Federation Service.
Syntax
Parameter Set: Default
Add-ADFSClaimDescription -ClaimType <String> -Name <String> [-IsAccepted <Boolean> ] [-IsOffered <Boolean> ] [-IsRequired <Boolean> ] [-Notes <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-ADFSClaimDescription cmdlet adds a claim description to the Federation Service.
Parameters
-ClaimType<String>
Specifies the claim type URN or URI of the claim. All claim descriptions must include a valid URN or URI.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsAccepted<Boolean>
Specifies that the claim should be published in federation metadata as a claim that the Federation Service accepts.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsOffered<Boolean>
Specifies that the claim should be published in federation metadata as a claim that the Federation Service offers.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsRequired<Boolean>
Specifies that the claim should be published in federation metadata as a claim that the Federation Service requires.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the friendly name of this claim.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Notes<String>
Specifies any notes for this claim description.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
- You can use claim descriptions to configure the list of claims that are available to be offered or accepted by AD FS 2.0.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Adds a new claim description for a custom Role claim.
C:\PS>Add-ADFSClaimDescription -name "Role" -ClaimType "https://fabrikam.com/role"