Get-AuthenticationWorkflowRegistrationTemplate

  • Article

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

Parameter Set: Default

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

Detailed 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 templates 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 hashtable containing the 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.

Parameters

-AuthenticationWorkflowName <String>

The display name of the authentication workflow which you wish to return.

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 authentication workflows via 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

Returns information on a specific Authentication Workflow Registration Template.

C:\PS> Add-PSSnapin FIMAutomation
C:\PS> Get-AuthenticationWorkflowRegistrationTemplate –AuthenticationWorkflowName “Password Reset AuthN Workflow”

.