Get-​Authentication​Workflow​Registration​Template

Gets an object of type AuthenticationWorkflowRegistrationTemplate that corresponds to an authentication workflow defined within the target Forefront Identity Manager service instance.

Syntax

Get-AuthenticationWorkflowRegistrationTemplate
   -AuthenticationWorkflowName <String>
   [-Uri <String>]
   [-Credential <PSCredential>]

Description

The Get-AuthenticationWorkflowRegistrationTemplate cmdlet gets 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.

Examples

Example 1: Get a specific authentication workflow registration template

$Template = Get-AuthenticationWorkflowRegistrationTemplate -AuthenticationWorkflowName "Password Reset AuthN Workflow"

This command authenticates the workflow template if the workflow with the specified name exists in the FIM Database.

Required Parameters

-AuthenticationWorkflowName

Specifies the display name of the authentication workflow which this cmdlet gets.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Credential

Specifies the user credentials required to access the Forefront Identity Manager service.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Uri

Specifies the uniform resource identifier (URI) for the Forefront Identity Manager service.

Type:String
Position:Named
Default value:Http://localhost:5725/ResourceManagementService
Accept pipeline input:False
Accept wildcard characters:False

Outputs

AuthenticationWorkflowRegistrationTemplate