Register-AuthenticationWorkflow

Registers a user for a Forefront Identity Manager service authentication workflow.

Syntax

Register-AuthenticationWorkflow
        -UserName <String>
        -AuthenticationWorkflowRegistrationTemplate <AuthenticationWorkflowRegistrationTemplate>
        [-Uri <String>]
        [-Credential <PSCredential>]

Description

Registers a user for a Forefront Identity Manager service authentication workflow. In order to register a user, an authentication workflow registration template that contains that users registration data must be created and supplied to this cmdlet.

Examples

Example 1: Register User for an Authentication Workflow

PS C:\> Register-AuthenticationWorkflow -UserName "domain\user1" -AuthenticationWorkflowRegistrationTemplate $Template

This command calls to register user domain\user1 using the specified template.

Example 2: Set Workflow template data and register a user for the workflow

PS C:\> $Template = Get-AuthenticationWorkflowRegistrationTemplate -AuthenticationWorkflowName "Password Reset AuthN Workflow"
          $Usertemplate = $template.Clone()
          $Usertemplate.GateRegistrationTemplates[0].Data[0].Value="answer1"
          $Usertemplate.GateRegistrationTemplates[0].Data[1].Value="answer2"
          $Usertemplate.GateRegistrationTemplates[0].Data[2].Value="answer3"

          Register-AuthenticationWorkflow -UserName "domain\user1" -AuthenticationWorkflowRegistrationTemplate $Usertemplate

This example uses the Get-AuthenticationWorkflowRegistrationTemplate cmdlet to get the password reset workflow template and assigned to the $Template variable. Then a copy of the template is created and assigned to $usertemplate variable.

Assuming the workflow has only one Questions and Answers Gate, 3 answers are set as part of the gate data for the first 3 questions of the gate data.

After the data is set for the gate, the register command is called to register user "domain\user1" using the specified template.

Required Parameters

-AuthenticationWorkflowRegistrationTemplate

Specifies an authentication workflow registration template that has been filled in with the gate registration data for the specified user.

Type:AuthenticationWorkflowRegistrationTemplate
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserName

Specifies the username of the user for which this cmdlet registers. Provide the username in the format: domain\username.

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 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

None