Skip to main content

SmartCredentialsApi

MethodHTTP requestDescription
activateSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/activateActivate a smart credential
changeSmartCredentialStateUsingPUTPUT /api/web/v1/smartcredentials/{id}/changestateChange smart credential state
completeSignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/completesignSmart credential complete signature
createSmartCredentialUsingPOSTPOST /api/web/v1/smartcredentialsCreate a smart credential
deleteSmartCredentialUsingDELETEDELETE /api/web/v1/smartcredentials/{id}Delete a smart credential
exportCertificateUsingGETGET /api/web/v1/smartcredentials/certificate/{id}/export/{format}Export a certificate from a smart credential
getSCDefnByNameUsingPOSTPOST /api/web/v1/scdefns/nameGet a smart credential definition by name
getSCDefnUsingGETGET /api/web/v1/scdefns/{id}Get a smart credential definition
getSmartCredentialBySerialNumberUsingGETGET /api/web/v1/smartcredentials/serialnumber/{sernum}Get a smart credential by serial number
getSmartCredentialUsingGETGET /api/web/v1/smartcredentials/{id}Get a smart credential
holdCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/holdHold a certificate from a smart credential
listAllowedSCDefnsUsingGETGET /api/web/v1/scdefns/users/{userId}List allowed smart credential definitions
listSCDefnsUsingGETGET /api/web/v1/scdefnsList smart credential definitions
revokeCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/revokeRevoke a certificate from a smart credential
startSignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/startsignSmart credential start signature
unassignSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/unassignUnassign a smart credential
unblockSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}/unblockUnblock a smart credential
unholdCertificateUsingPUTPUT /api/web/v1/smartcredentials/certificate/{id}/unholdUnhold a certificate from a smart credential
updateSmartCredentialUsingPUTPUT /api/web/v1/smartcredentials/{id}Update a smart credential

activateSmartCredentialUsingPUT​

ActivateSmartCredentialResult activateSmartCredentialUsingPUT(id, activateSmartCredentialParms)

Activate a smart credential

Activate the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential to be activated.
activateSmartCredentialParmsActivateSmartCredentialParms

Return type​

ActivateSmartCredentialResult

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

changeSmartCredentialStateUsingPUT​

changeSmartCredentialStateUsingPUT(id, smartCredentialChangeStateParms)

Change smart credential state

Change the state of the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential whose state is to be changed.
smartCredentialChangeStateParmsSmartCredentialChangeStateParms

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

completeSignSmartCredentialUsingPUT​

SmartCredentialCompleteSignResponse completeSignSmartCredentialUsingPUT(id, smartCredentialCompleteSignParms)

Smart credential complete signature

Smart credential complete sign. Caller requires the SMARTCREDENTIALSSIGNATURE:ADD permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential.
smartCredentialCompleteSignParmsSmartCredentialCompleteSignParms

Return type​

SmartCredentialCompleteSignResponse

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

createSmartCredentialUsingPOST​

SmartCredential createSmartCredentialUsingPOST(smartCredentialParms)

Create a smart credential

Create a smart credential for a user. Caller requires the SMARTCREDENTIALS:ADD permission.

Example​

Parameters​

NameTypeDescriptionNotes
smartCredentialParmsSmartCredentialParms

Return type​

SmartCredential

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

deleteSmartCredentialUsingDELETE​

deleteSmartCredentialUsingDELETE(id)

Delete a smart credential

Delete the specified smart credential. Caller requires the SMARTCREDENTIALS:REMOVE permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential to be deleted.

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

exportCertificateUsingGET​

ExportCertificate exportCertificateUsingGET(id, format)

Export a certificate from a smart credential

Export the specified certificate. Caller requires the SMARTCREDENTIALS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the certificate to be exported.
formatStringThe format in which to export the certificate.[enum: CA, P7, CERT]

Return type​

ExportCertificate

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getSCDefnByNameUsingPOST​

SCDefn getSCDefnByNameUsingPOST(scDefnGetParms)

Get a smart credential definition by name

Get the smart credential definition for the specified name. Caller requires the SCDEFNS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
scDefnGetParmsSCDefnGetParms

Return type​

SCDefn

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getSCDefnUsingGET​

SCDefn getSCDefnUsingGET(id)

Get a smart credential definition

Get the smart credential definition for the specified UUID. Caller requires the SCDEFNS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential definition to be retrieved.

Return type​

SCDefn

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getSmartCredentialBySerialNumberUsingGET​

SmartCredential getSmartCredentialBySerialNumberUsingGET(sernum)

Get a smart credential by serial number

Get the specified smart credential by serial number. Caller requires the SMARTCREDENTIALS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
sernumStringThe serial number of the smart credential to be retrieved.

Return type​

SmartCredential

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getSmartCredentialUsingGET​

SmartCredential getSmartCredentialUsingGET(id, revocationInfo)

Get a smart credential

Get the specified smart credential. Caller requires the SMARTCREDENTIALS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential to be retrieved.
revocationInfoBooleanOptional flag indicating if revocation inforamtion should be returned. Defaults to false if not specified.[optional] [default to false]

Return type​

SmartCredential

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

holdCertificateUsingPUT​

holdCertificateUsingPUT(id)

Hold a certificate from a smart credential

Hold the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the certificate to be put on hold.

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

listAllowedSCDefnsUsingGET​

List<SCDefn> listAllowedSCDefnsUsingGET(userId)

List allowed smart credential definitions

List allowed smart credential definitions. Caller requires the SCDEFNS:VIEW permission.

Example​

Parameters​

NameTypeDescriptionNotes
userIdStringThe UUID of the user whose allowed smart credential definitions to be fetched.

Return type​

List<SCDefn>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

listSCDefnsUsingGET​

List<SCDefn> listSCDefnsUsingGET()

List smart credential definitions

List all the smart credential definition. Caller requires the SCDEFNS:VIEW permission.

Example​

Parameters​

This endpoint does not need any parameter.

Return type​

List<SCDefn>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

revokeCertificateUsingPUT​

revokeCertificateUsingPUT(id)

Revoke a certificate from a smart credential

Revoke the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the certificate to be revoked.

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

startSignSmartCredentialUsingPUT​

SmartCredentialStartSignResponse startSignSmartCredentialUsingPUT(id, smartCredentialStartSignParms)

Smart credential start signature

Smart credential start sign. Caller requires the SMARTCREDENTIALSSIGNATURE:ADD permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential.
smartCredentialStartSignParmsSmartCredentialStartSignParms

Return type​

SmartCredentialStartSignResponse

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unassignSmartCredentialUsingPUT​

unassignSmartCredentialUsingPUT(id)

Unassign a smart credential

Unassign the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential to be unassigned.

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unblockSmartCredentialUsingPUT​

SmartCredentialUnblockResponse unblockSmartCredentialUsingPUT(id, smartCredentialUnblockParms)

Unblock a smart credential

Unblock the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential that is to be unblocked.
smartCredentialUnblockParmsSmartCredentialUnblockParms

Return type​

SmartCredentialUnblockResponse

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unholdCertificateUsingPUT​

unholdCertificateUsingPUT(id)

Unhold a certificate from a smart credential

Unhold the specified certificate. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the certificate to be put removed from hold.

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

updateSmartCredentialUsingPUT​

updateSmartCredentialUsingPUT(id, smartCredentialParms)

Update a smart credential

Update the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the smart credential to be modified.
smartCredentialParmsSmartCredentialParms

Return type​

null (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-