New-AdfsSamlEndpoint
Creates a SAML protocol endpoint object.
Syntax
Default (Default)
New-AdfsSamlEndpoint
-Binding <String>
-Protocol <String>
-Uri <Uri>
[-IsDefault <Boolean>]
[-Index <Int32>]
[-ResponseUri <Uri>]
[<CommonParameters>]
Description
The New-AdfsSamlEndpoint cmdlet creates a Security Assertion Markup Language (SAML) protocol endpoint object.
Examples
Example 1: Create a SAML endpoint and assign it to a relying party
PS C:\> $EP = New-AdfsSamlEndpoint -Binding "POST" -Protocol "SAMLAssertionConsumer" -Uri "https://fabrikam.com/saml/ac"
PS C:\> Set-AdfsRelyingPartyTrust -TargetName "My application" -SamlEndpoint $EP
The first command creates a SAML endpoint, and then stores it in the $EP variable.
The second command uses the Set-AdfsRelyingPartyTrust cmdlet to assign the endpoint stored in $EP to a relying party trust named My application.
Parameters
-Binding
Specifies the binding type of the endpoint. The acceptable values for this parameter are: POST, SOAP, Artifact, and Redirect.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Artifact, POST, Redirect, SOAP |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Index
Specifies the index that is defined for this endpoint.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsDefault
Indicates whether this is a default endpoint for the particular protocol type.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Protocol
Specifies the type of service at the endpoint. The acceptable values for this parameter are: SAMLSingleSignOn, SAMLArtifactResolution, SAMLLogout, and SAMLAssertionConsumer.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | SAMLArtifactResolution, SAMLAssertionConsumer, SAMLLogout, SAMLSingleSignOn |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseUri
Specifies the response URI for the endpoint.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Uri
Specifies the URI of this endpoint.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
Microsoft.IdentityServer.PowerShell.Resources.SamlEndpoint
This cmdlet generates a class structure that represents a SAML endpoint resource object.
Notes
- You can associate this object with a relying party trust or claims provider trust by using the corresponding cmdlets.