Get-AuthenticationWorkflowRegistrationTemplate
Returns an object of type AuthenticationWorkflowRegistrationTemplate that corresponds to an authentication workflow defined within the target Forefront Identity Manager service instance. The workflow is specified by passing the name of the workflow as parameter.
Syntax
Default (Default)
Get-AuthenticationWorkflowRegistrationTemplate
-AuthenticationWorkflowName <String>
[-Uri <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
Description
Returns an object of type AuthenticationWorkflowRegistrationTemplate that corresponds to an authentication workflow defined within the target Forefront Identity Manager service instance. The workflow is specified by passing the name of the workflow as parameter. The registration workflow template contain a collection of gate registration templates which correspond to the interactive gates (authentication activities) contained within the authentication workflow. Each registration gate in turn contains a Data property which is an array of name/value pairs of data required to register for the gate.
Use the returned template objects to register a user for an authentication workflow using the Register-AuthenticationWorkflow cmdlet.
Examples
Get a specific authentication workflow registration template
$template = Get-AuthenticationWorkflowRegistrationTemplate -AuthenticationWorkflowName "Password Reset AuthN Workflow"
In this example command will the authentication workflow template if the workflow with the specified name exists in the FIM Database.
Parameters
-AuthenticationWorkflowName
The display name of the authentication workflow which you wish to return.
Parameter properties
| Type: | String |
| 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 |
-Credential
The user credentials required to access the Forefront Identity Manager service.
Parameter properties
| Type: | PSCredential |
| 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
The uniform resource identifier for the Forefront Identity Manager service.
Parameter properties
| Type: | String |
| Default value: | Http://localhost:5725/ResourceManagementService |
| 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 |
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.