Skip to main content

SmartCredentialsApi

MethodHTTP requestDescription
activate_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}/activateActivate a smart credential
change_smart_credential_state_using_putPUT /api/web/v1/smartcredentials/{id}/changestateChange smart credential state
complete_sign_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}/completesignSmart credential complete signature
create_smart_credential_using_postPOST /api/web/v1/smartcredentialsCreate a smart credential
delete_smart_credential_using_deleteDELETE /api/web/v1/smartcredentials/{id}Delete a smart credential
export_certificate_using_getGET /api/web/v1/smartcredentials/certificate/{id}/export/{format}Export a certificate from a smart credential
get_sc_defn_by_name_using_postPOST /api/web/v1/scdefns/nameGet a smart credential definition by name
get_sc_defn_using_getGET /api/web/v1/scdefns/{id}Get a smart credential definition
get_smart_credential_by_serial_number_using_getGET /api/web/v1/smartcredentials/serialnumber/{sernum}Get a smart credential by serial number
get_smart_credential_using_getGET /api/web/v1/smartcredentials/{id}Get a smart credential
hold_certificate_using_putPUT /api/web/v1/smartcredentials/certificate/{id}/holdHold a certificate from a smart credential
list_allowed_sc_defns_using_getGET /api/web/v1/scdefns/users/{userId}List allowed smart credential definitions
list_sc_defns_using_getGET /api/web/v1/scdefnsList smart credential definitions
revoke_certificate_using_putPUT /api/web/v1/smartcredentials/certificate/{id}/revokeRevoke a certificate from a smart credential
start_sign_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}/startsignSmart credential start signature
unassign_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}/unassignUnassign a smart credential
unblock_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}/unblockUnblock a smart credential
unhold_certificate_using_putPUT /api/web/v1/smartcredentials/certificate/{id}/unholdUnhold a certificate from a smart credential
update_smart_credential_using_putPUT /api/web/v1/smartcredentials/{id}Update a smart credential

activate_smart_credential_using_put​

ActivateSmartCredentialResult activate_smart_credential_using_put(id, activate_smart_credential_parms)

Activate a smart credential

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

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential to be activated.
activate_smart_credential_parmsActivateSmartCredentialParms

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-

change_smart_credential_state_using_put​

change_smart_credential_state_using_put(id, smart_credential_change_state_parms)

Change smart credential state

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential whose state is to be changed.
smart_credential_change_state_parmsSmartCredentialChangeStateParms

Return type​

void (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-

complete_sign_smart_credential_using_put​

SmartCredentialCompleteSignResponse complete_sign_smart_credential_using_put(id, smart_credential_complete_sign_parms)

Smart credential complete signature

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential.
smart_credential_complete_sign_parmsSmartCredentialCompleteSignParms

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-

create_smart_credential_using_post​

SmartCredential create_smart_credential_using_post(smart_credential_parms)

Create a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
smart_credential_parmsSmartCredentialParms

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-

delete_smart_credential_using_delete​

delete_smart_credential_using_delete(id)

Delete a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential to be deleted.

Return type​

void (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-

export_certificate_using_get​

ExportCertificate export_certificate_using_get(id, format)

Export a certificate from a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the certificate to be exported.
formatstrThe format in which to export the certificate.

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-

get_sc_defn_by_name_using_post​

SCDefn get_sc_defn_by_name_using_post(sc_defn_get_parms)

Get a smart credential definition by name

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
sc_defn_get_parmsSCDefnGetParms

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-

get_sc_defn_using_get​

SCDefn get_sc_defn_using_get(id)

Get a smart credential definition

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe 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-

get_smart_credential_by_serial_number_using_get​

SmartCredential get_smart_credential_by_serial_number_using_get(sernum)

Get a smart credential by serial number

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
sernumstrThe 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-

get_smart_credential_using_get​

SmartCredential get_smart_credential_using_get(id, revocation_info=revocation_info)

Get a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential to be retrieved.
revocation_infoboolOptional 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-

hold_certificate_using_put​

hold_certificate_using_put(id)

Hold a certificate from a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

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

Return type​

void (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-

list_allowed_sc_defns_using_get​

List[SCDefn] list_allowed_sc_defns_using_get(user_id)

List allowed smart credential definitions

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
user_idstrThe 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-

list_sc_defns_using_get​

List[SCDefn] list_sc_defns_using_get()

List smart credential definitions

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

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-

revoke_certificate_using_put​

revoke_certificate_using_put(id)

Revoke a certificate from a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the certificate to be revoked.

Return type​

void (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-

start_sign_smart_credential_using_put​

SmartCredentialStartSignResponse start_sign_smart_credential_using_put(id, smart_credential_start_sign_parms)

Smart credential start signature

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential.
smart_credential_start_sign_parmsSmartCredentialStartSignParms

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-

unassign_smart_credential_using_put​

unassign_smart_credential_using_put(id)

Unassign a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential to be unassigned.

Return type​

void (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-

unblock_smart_credential_using_put​

SmartCredentialUnblockResponse unblock_smart_credential_using_put(id, smart_credential_unblock_parms)

Unblock a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential that is to be unblocked.
smart_credential_unblock_parmsSmartCredentialUnblockParms

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-

unhold_certificate_using_put​

unhold_certificate_using_put(id)

Unhold a certificate from a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

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

Return type​

void (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-

update_smart_credential_using_put​

update_smart_credential_using_put(id, smart_credential_parms)

Update a smart credential

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

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the smart credential to be modified.
smart_credential_parmsSmartCredentialParms

Return type​

void (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-