Register-AuthenticationWorkflow
Registers a user for a Forefront Identity Manager service authentication workflow.
Syntax
Parameter Set: Default
Register-AuthenticationWorkflow -AuthenticationWorkflowRegistrationTemplate <AuthenticationWorkflowRegistrationTemplate> -UserName <String> [-Credential <PSCredential> ] [-Uri <String> ] [ <CommonParameters>]
Detailed 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.
Parameters
-AuthenticationWorkflowRegistrationTemplate < AuthenticationWorkflowRegistrationTemplate >
An authentication workflow registration template that has been filled in with the gate registration data for the specified user.
Required? |
true |
Position? |
named |
Default Value |
No default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserName <String>
The username of the user for which you wish to register. Please provide the username in the format: domain\username.
Required? |
true |
Position? |
named |
Default Value |
No default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential <PSCredential>
The user credentials required to access the Forefront Identity Manager service.
Required? |
false |
Position? |
named |
Default Value |
No default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Uri <String>
The uniform resource identifier for the Forefront Identity Manager service.
Required? |
false |
Position? |
named |
Default Value |
No default |
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.
Notes
Example 1
In this example, the cmdlet is called to register user “domain\user1” using the specified template.
C:\PS> Add-PSSnapin FIMAutomation
C:\PS> $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
.