SmartCredentialsApi
| Method | HTTP request | Description |
|---|---|---|
| ActivateSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id}/activate | Activate a smart credential |
| ChangeSmartCredentialStateUsingPUT | PUT /api/web/v1/smartcredentials/{id}/changestate | Change smart credential state |
| CompleteSignSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id}/completesign | Smart credential complete signature |
| CreateSmartCredentialUsingPOST | POST /api/web/v1/smartcredentials | Create a smart credential |
| DeleteSmartCredentialUsingDELETE | DELETE /api/web/v1/smartcredentials/{id} | Delete a smart credential |
| ExportCertificateUsingGET | GET /api/web/v1/smartcredentials/certificate/{id}/export/{format} | Export a certificate from a smart credential |
| GetSCDefnByNameUsingPOST | POST /api/web/v1/scdefns/name | Get a smart credential definition by name |
| GetSCDefnUsingGET | GET /api/web/v1/scdefns/{id} | Get a smart credential definition |
| GetSmartCredentialBySerialNumberUsingGET | GET /api/web/v1/smartcredentials/serialnumber/{sernum} | Get a smart credential by serial number |
| GetSmartCredentialUsingGET | GET /api/web/v1/smartcredentials/{id} | Get a smart credential |
| HoldCertificateUsingPUT | PUT /api/web/v1/smartcredentials/certificate/{id}/hold | Hold a certificate from a smart credential |
| ListAllowedSCDefnsUsingGET | GET /api/web/v1/scdefns/users/{userId} | List allowed smart credential definitions |
| ListSCDefnsUsingGET | GET /api/web/v1/scdefns | List smart credential definitions |
| RevokeCertificateUsingPUT | PUT /api/web/v1/smartcredentials/certificate/{id}/revoke | Revoke a certificate from a smart credential |
| StartSignSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id}/startsign | Smart credential start signature |
| UnassignSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id}/unassign | Unassign a smart credential |
| UnblockSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id}/unblock | Unblock a smart credential |
| UnholdCertificateUsingPUT | PUT /api/web/v1/smartcredentials/certificate/{id}/unhold | Unhold a certificate from a smart credential |
| UpdateSmartCredentialUsingPUT | PUT /api/web/v1/smartcredentials/{id} | Update a smart credential |
ActivateSmartCredentialUsingPUT
ActivateSmartCredentialResult ActivateSmartCredentialUsingPUT (string id, ActivateSmartCredentialParms activateSmartCredentialParms)
Activate a smart credential
Activate the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.
Using the ActivateSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential to be activated. | |
| activateSmartCredentialParms | ActivateSmartCredentialParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ChangeSmartCredentialStateUsingPUT
void ChangeSmartCredentialStateUsingPUT (string id, SmartCredentialChangeStateParms smartCredentialChangeStateParms)
Change smart credential state
Change the state of the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the ChangeSmartCredentialStateUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential whose state is to be changed. | |
| smartCredentialChangeStateParms | SmartCredentialChangeStateParms |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
CompleteSignSmartCredentialUsingPUT
SmartCredentialCompleteSignResponse CompleteSignSmartCredentialUsingPUT (string id, SmartCredentialCompleteSignParms smartCredentialCompleteSignParms)
Smart credential complete signature
Smart credential complete sign. Caller requires the SMARTCREDENTIALSSIGNATURE:ADD permission.
Example
Using the CompleteSignSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential. | |
| smartCredentialCompleteSignParms | SmartCredentialCompleteSignParms |
Return type
SmartCredentialCompleteSignResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
CreateSmartCredentialUsingPOST
SmartCredential CreateSmartCredentialUsingPOST (SmartCredentialParms smartCredentialParms)
Create a smart credential
Create a smart credential for a user. Caller requires the SMARTCREDENTIALS:ADD permission.
Example
Using the CreateSmartCredentialUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| smartCredentialParms | SmartCredentialParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
DeleteSmartCredentialUsingDELETE
void DeleteSmartCredentialUsingDELETE (string id)
Delete a smart credential
Delete the specified smart credential. Caller requires the SMARTCREDENTIALS:REMOVE permission.
Example
Using the DeleteSmartCredentialUsingDELETEWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential to be deleted. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ExportCertificateUsingGET
ExportCertificate ExportCertificateUsingGET (string id, string format)
Export a certificate from a smart credential
Export the specified certificate. Caller requires the SMARTCREDENTIALS:VIEW permission.
Example
Using the ExportCertificateUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the certificate to be exported. | |
| format | string | The format in which to export the certificate. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSCDefnByNameUsingPOST
SCDefn GetSCDefnByNameUsingPOST (SCDefnGetParms sCDefnGetParms)
Get a smart credential definition by name
Get the smart credential definition for the specified name. Caller requires the SCDEFNS:VIEW permission.
Example
Using the GetSCDefnByNameUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sCDefnGetParms | SCDefnGetParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSCDefnUsingGET
SCDefn GetSCDefnUsingGET (string id)
Get a smart credential definition
Get the smart credential definition for the specified UUID. Caller requires the SCDEFNS:VIEW permission.
Example
Using the GetSCDefnUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential definition to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSmartCredentialBySerialNumberUsingGET
SmartCredential GetSmartCredentialBySerialNumberUsingGET (string sernum)
Get a smart credential by serial number
Get the specified smart credential by serial number. Caller requires the SMARTCREDENTIALS:VIEW permission.
Example
Using the GetSmartCredentialBySerialNumberUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sernum | string | The serial number of the smart credential to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GetSmartCredentialUsingGET
SmartCredential GetSmartCredentialUsingGET (string id, bool? revocationInfo = null)
Get a smart credential
Get the specified smart credential. Caller requires the SMARTCREDENTIALS:VIEW permission.
Example
Using the GetSmartCredentialUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential to be retrieved. | |
| revocationInfo | bool? | Optional flag indicating if revocation inforamtion should be returned. Defaults to false if not specified. | [optional] [default to false] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
HoldCertificateUsingPUT
void HoldCertificateUsingPUT (string id)
Hold a certificate from a smart credential
Hold the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the HoldCertificateUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the certificate to be put on hold. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ListAllowedSCDefnsUsingGET
List<SCDefn> ListAllowedSCDefnsUsingGET (string userId)
List allowed smart credential definitions
List allowed smart credential definitions. Caller requires the SCDEFNS:VIEW permission.
Example
Using the ListAllowedSCDefnsUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | The UUID of the user whose allowed smart credential definitions to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ListSCDefnsUsingGET
List<SCDefn> ListSCDefnsUsingGET ()
List smart credential definitions
List all the smart credential definition. Caller requires the SCDEFNS:VIEW permission.
Example
Using the ListSCDefnsUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
RevokeCertificateUsingPUT
void RevokeCertificateUsingPUT (string id)
Revoke a certificate from a smart credential
Revoke the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the RevokeCertificateUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the certificate to be revoked. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
StartSignSmartCredentialUsingPUT
SmartCredentialStartSignResponse StartSignSmartCredentialUsingPUT (string id, SmartCredentialStartSignParms smartCredentialStartSignParms)
Smart credential start signature
Smart credential start sign. Caller requires the SMARTCREDENTIALSSIGNATURE:ADD permission.
Example
Using the StartSignSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential. | |
| smartCredentialStartSignParms | SmartCredentialStartSignParms |
Return type
SmartCredentialStartSignResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
UnassignSmartCredentialUsingPUT
void UnassignSmartCredentialUsingPUT (string id)
Unassign a smart credential
Unassign the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the UnassignSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential to be unassigned. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
UnblockSmartCredentialUsingPUT
SmartCredentialUnblockResponse UnblockSmartCredentialUsingPUT (string id, SmartCredentialUnblockParms smartCredentialUnblockParms)
Unblock a smart credential
Unblock the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the UnblockSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential that is to be unblocked. | |
| smartCredentialUnblockParms | SmartCredentialUnblockParms |
Return type
SmartCredentialUnblockResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
UnholdCertificateUsingPUT
void UnholdCertificateUsingPUT (string id)
Unhold a certificate from a smart credential
Unhold the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the UnholdCertificateUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the certificate to be put removed from hold. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
UpdateSmartCredentialUsingPUT
void UpdateSmartCredentialUsingPUT (string id, SmartCredentialParms smartCredentialParms)
Update a smart credential
Update the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.
Example
Using the UpdateSmartCredentialUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the smart credential to be modified. | |
| smartCredentialParms | SmartCredentialParms |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |