ExecuteOperations.GetProposedAdminPin Method

Article
10/02/2012

Return the proposed smart card administrator PIN.

Namespace: Microsoft.Clm.Provision
Assembly: Microsoft.Clm.Provision (in Microsoft.Clm.Provision.dll)

Usage

'Usage
Dim smartcardUuid As Guid
Dim returnValue As String

returnValue = ExecuteOperations.GetProposedAdminPin(smartcardUuid)

Syntax

'Declaration
Public Shared Function GetProposedAdminPin ( _
    smartcardUuid As Guid _
) As String

public static string GetProposedAdminPin (
    Guid smartcardUuid
)

public:
static String^ GetProposedAdminPin (
    Guid smartcardUuid
)

public static String GetProposedAdminPin (
    Guid smartcardUuid
)

public static function GetProposedAdminPin (
    smartcardUuid : Guid
) : String

Parameters

smartcardUuid
A Guid object that identifies the smart card for which to retrieve the proposed administrator PIN.

Return Value

A String object that contains the smart card’s proposed administrator PIN.

Remarks

This method is only applicable for PKCS#11 based smart cards that use an administrator PIN for administrative authentication to the smart card. This call is not valid for Base CSP based smart cards. For PKCS#11 administrator PIN based cards, FIM CM allows for a two step process of updating the smart card’s administrator PIN. First, a new administrator PIN would be set as proposed. Second, after confirmation of the action being performed on the smart card, the administrator PIN would be set as active in the FIM CM database. A given PKCS#11 smart card in FIM CM can have one active administrator PIN and one proposed administrator PIN.

In order for a call to this method to succeed, the caller of the method must be authorized to call the methods in the Sensitive API group. The Sensitive API group includes those methods where the caller has access to sensitive data. This includes the administrator PIN, the user PIN, the Base CSP administrator authentication key, and/or the Base CSP challenge response information.

To allow for a user, or a group of users, to be authorized to call the methods in the Sensitive API group, FIM CM must be configured as follows:

Open the web.config file that is associated with the FIM CM Web Virtual Directory (the default location of this file is %programfiles%\Microsoft Certificate Lifecycle Manager\web\web.config).
Locate the configuration section for the Sensitive API group, which resembles the following:
<add key="Clm.ProvisionApi.SensitiveApiGroup" value="" />
By default, FIM CM does not authorize any users to call the methods in the Sensitive API group.
Set the value to the name of a security group that contains the users who are to be authorized to call the methods in the Sensitive API group. The security group must be specified in the "domainname\groupname" format. For example:
<add key="Clm.ProvisionApi.SensitiveApiGroup" value="domain\SensitiveApiUserGroup" />
Save the web.config file.

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

Development Platforms

Windows 2008 x64 Edition

Target Platforms

Windows XP SP3, Windows Vista SP1+, Windows 7, Windows Server 2008, Windows Server 2008 R2

Share via