Partager via

ClmUtils.CreateRecoverOnBehalfRequest Method

  • Article

Creates a recover on behalf of a request in Forefront Identity Manager Certificate Management (FIM CM).

Namespace: Mms_Metaverse
Assembly: ClmUtils (in ClmUtils.dll)

Usage

'Usage
Dim instance As ClmUtils
Dim targetCLMMA As ConnectedMA
Dim aDObjectGUID As Guid
Dim profileTemplateName As String

instance.CreateRecoverOnBehalfRequest(targetCLMMA, aDObjectGUID, profileTemplateName)

Syntax

'Declaration
Public Sub CreateRecoverOnBehalfRequest ( _
    targetCLMMA As ConnectedMA, _
    aDObjectGUID As Guid, _
    profileTemplateName As String _
)

public void CreateRecoverOnBehalfRequest (
    ConnectedMA targetCLMMA,
    Guid aDObjectGUID,
    string profileTemplateName
)

public:
void CreateRecoverOnBehalfRequest (
    ConnectedMA^ targetCLMMA, 
    Guid aDObjectGUID, 
    String^ profileTemplateName
)

public void CreateRecoverOnBehalfRequest (
    ConnectedMA targetCLMMA, 
    Guid aDObjectGUID, 
    String profileTemplateName
)

public function CreateRecoverOnBehalfRequest (
    targetCLMMA : ConnectedMA, 
    aDObjectGUID : Guid, 
    profileTemplateName : String
)

Parameters

  • targetCLMMA
    The FIM CM management agent through which the new object is provisioned.
  • aDObjectGUID
    The objectGuid of the associated Active Directory Domain Services (AD DS) account for which you create the request. This must be imported to the metaverse through the Active Directory management agent.
  • profileTemplateName
    The name of the profile template to which you are trying to provision the request.

Exceptions

Exception type Condition
System.ArgumentException

A required parameter is not present.
System.ArgumentNullException

A required parameter is null.
AttributeNotInInclusionListException

A required attribute is not selected in the management agent.
NoSuchObjectTypeException

The object type that is referenced is not in the schema.
UnexpectedDataException

There was an unexpected error, possibly because the request type was not valid.

Remarks

This method implements the following logic:

  • Verifies that there is at least one connected profile; otherwise, it throws an UnexpectedDataException.

  • Verifies that the profile is in one of the following states that can support the recover on behalf request:

    • Disabled

    • Retired

  • Checks the connector space of the FIM CM management agent and determines whether any connected pending requests of the same profile template type were already submitted by the specified service account. If there are any, it does not reprovision the request, and it throws an UnexpectedDataException exception.

  • Checks the connector space to verify whether there is a connected profile in a recovered state. If there is one, it does not reprovision the request.

  • Otherwise it provisions a new recover on behalf of the request into the connector space for that object.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

See Also

Reference

ClmUtils Class
ClmUtils Members
Mms_Metaverse Namespace
ClmUtils Class