CA lists management

S
Written by Sergiiy
Updated 11 months ago

All applications bellow support trusted mode, i_customer = 1 should be supplied in that mode.

createCAList()

This application is used to create a CA list.

Required parameters:

  • name - a name of the certificate. String.
  • ca_list- value of CA list. String. The value depends on CA list type:
    • base64-encoded CA list in PEM format for 'Uploaded' type
    • path to folder for 'Local Folder' type

 

Optional parameters: 

  • i_ca_list_type - type of the CA list. See getSystemDictionary(ca_list_types). Integer. Default is 'Uploaded'.

Returns:

  • result - OK - String.
  • i_ca_list - id of the created CA list. Integer.

  • XMLRPC fault in case of any error.

updateCAList()

This application is used to update an existing CA list.

Required parameters:

  • i_ca_list - id of the updated CA list. Integer.

Optional parameters:

  • name - a name of the certificate. String.
  • i_ca_list_type - type of the CA list. See getSystemDictionary(ca_list_types). Integer.
  • ca_list - value of CA list. String. The value depends on CA list type - see createCAList() for details.

Returns:

  • result - OK - String.
  • i_ca_list - id of the updated CA list. Integer.

  • XMLRPC fault in case of any error.

deleteCAList()

This application is used to delete an existing CA list.

Required parameters:

  • i_ca_list - id of the deleted CA list. Integer.

Returns:

  • result - OK - String.
  • i_ca_list - id of the deleted CA list. Integer.

  • XMLRPC fault in case of any error.

getCAListInfo()

This application is used to get CA list details.

Required parameters:

  • i_ca_list - id of the CA list. Integer.

Returns:

  • result - OK - String.
  • ca_list - detailed info of the CA list. Structure.

  • XMLRPC fault in case of any error.

getCAListsList()

This application is used to get CA lists list.

Optional parameters:

  • name_pattern - Pattern to filter certificates by name (SQL syntax for ILIKE operator is used). String.
  • limit - Limit result by limit entries. Integer.
  • offset - Skip first offset entries in result. Integer.

Returns:

  • result - OK - String.
  • ca_lists - list of detailed entries as getCAListInfo returns. Array.

  • XMLRPC fault in case of any error.
Did this answer your question?