externalSubmitTemporaryCardRetireRequest
Submits a request to retire a temporary smart card for a specified user. After the request is submitted, it will be processed in the same way as any other request within the Forefront Identity Manager Certificate Management (FIM CM) and subject to the workflow and policy rules associated with the profile template.
externalSubmitReplaceRequest(
@serial varchar(50),
@registration_data ntext = NULL,
@comments nvarchar(256),
@request_uuid uniqueidentifier OUTPUT,
@request_priority tinyint = 0
)
Parameters
| Parameter | Description |
|---|---|
@serial |
[in] The smart card serial number for the temporary card to retire, prefixed with the manufacturer identification number. |
@registration_data |
[in] An XML document that contains the name/value pairs for any data that is required for the FIM CM profile template retire policy. This parameter can be NULL. |
@comments |
[in] Comment stored for the request. This parameter can be NULL. |
@request_uuid |
[out] A UUID that is the unique identifier for the submitted request. This identifier can be used to determine the status of the request using the externalGetStatus stored procedure. |
@request_priority |
[in] An integer value between 0 and 255 indicating the priority of the request. Zero is the highest priority and 255 is the lowest. This parameter can be NULL. |
Return Value
Zero if the procedure succeeds, otherwise one of the following error codes.
| Value | Meaning |
|---|---|
-1 |
The cause of the error is unknown. |
-2 |
The attempt to create the request failed. |
-3 |
The data is not valid. |
-4 |
The attempt to submit the request failed. |
Example
The following code example shows how to submit a request to retire a temporary smart card.
DECLARE @RC int
DECLARE @serial varchar(50)
DECLARE @comments nvarchar(256)
DECLARE @request_uuid uniqueidentifier
DECLARE @request_priority tinyint
-- Set the parameter values
SET @serial = 'A.E.T. Europe B.V.:5144018935907492'
SET @comments = N'Temp Card Retire Request Submitted by External Api (with comments)'
SET @request_priority = 111
EXEC @RC = [clm].[dbo].[externalSubmitTemporaryCardRetireRequest]
@serial,
NULL,
@comments,
@request_uuid OUTPUT ,
@request_priority
PRINT @request_uuid
RPINT @RC
Requirements
Microsoft SQL Server® 2005 Service Pack 1 or SQL Server 2000 Service Pack 4