| title | description | keywords | author | ms.author | manager | ms.date | ms.topic | ms.service | ms.assetid | audience | ms.reviewer | ms.suite |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get smart card proposed PIN | Microsoft Docs |
Using the MIM CM REST API GET command to retrieve the server-generated user PIN. |
billmath |
billmath |
amycolannino |
09/14/2023 |
reference |
microsoft-identity-manager |
ced93932-9912-4b32-9586-ada69b38a796 |
developer |
mwahl |
ems |
Gets the server-generated user PIN.
Important
The server only sets the PIN if the profile template policy indicates that it should be done. Otherwise, the user should supply the PIN.
Note
The URLs in this article are relative to the hostname that's chosen during API deployment, such as https://api.contoso.com.
| Method | Request URL |
|---|---|
| GET | /CertificateManagement/api/v1.0/smartcards/{id}/serverproposedpin |
| Parameter | Description |
|---|
id | The smart card ID that's specific to Microsoft Identity Manager (MIM) Certificate Management (CM). The ID is obtained from the Microsft.Clm.Shared.Smartcard object.
| Parameter | Description |
|---|---|
| atr | The smart card answer-to-reset (ATR) string. |
| cardid | The smart card ID. |
| challenge | A base-64 encoded string representing the challenge that's issued by the smart card. |
For common request headers, see HTTP request and response headers in CM REST API service details.
None.
This section describes the response.
| Code | Description |
|---|---|
| 200 | OK |
| 204 | No content |
| 403 | Forbidden |
| 500 | Internal Error |
For common response headers, see HTTP request and response headers in CM REST API service details.
On success, returns a string that represents the PIN that's proposed by the server.
This section provides an example to get the server-generated user PIN.
GET /CertificateManagement/api/v1.0/smartcards/C6BAD97C-F97F-4920-8947-BE980C98C6B5/serverproposedpin HTTP/1.1
HTTP/1.1 200 OK
... body coming soon