[Index]
Used to generate self-signed certificates or creating certificate requests to be signed by a third-party certificate authority.
Model ref.: data/Certificate
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"certificate_request": {
"type": "boolean",
"description": "If true, indicates that the system will generate a certificate signing request that can be signed by a third-party CA. If false, the system will generate a self-signed root certificate.",
"title": "Generate Certificate Signing Request"
},
"valid_from": {
"default": 0,
"type": "integer",
"description": "Time when the certificate starts to be valid. This is the number of seconds from when the certificate is generated. Ignored when \"Generate Certificate Signing Request\" is true.",
"title": "Valid From"
},
"name": {
"required": true,
"type": "string",
"description": "A textual identifier for the certificate.",
"title": "Name"
},
"csr_file_reference": {
"readonly": true,
"type": "string",
"description": "An internal reference to the generated certificate signing request file, when \"Generate Certificate Signing Request\" is true. This file will never be exposed to users, including administrators with the highest privileges.",
"title": "Certificate Request File Reference"
},
"valid_to": {
"default": 315360000,
"type": "integer",
"description": "How long the certificate will be valid for from the time of generation. The value is in seconds. Default is 315360000 seconds (10 years). Ignored when \"Generate Certificate Signing Request\" is true.",
"title": "Valid To"
},
"key_file_reference": {
"readonly": true,
"type": "string",
"description": "An internal reference for the generated private key file. This file will never be exposed to users, including administrators with the highest privileges.",
"title": "Private Key File Reference"
},
"expiry_date": {
"title": "Expires",
"type": "string",
"description": "The expiry date of the certificate.",
"format": "date-time"
},
"cert_file_reference": {
"readonly": true,
"type": "string",
"description": "An internal reference to the certificate file that is generated internally or uploaded authorized users. This certificate is generated automatically when \"Generate Certificate Signing Request\" is false. The CA-signed certicate must be uploaded manually when \"Generate Certificate Signing Request\" is true. This file will never be exposed to users, including administrators with the highest privileges.",
"title": "Certificate File Reference"
},
"hash_algorithm": {
"default": "sha256",
"choices": [
{
"value": "sha256",
"title": "sha256"
}
],
"type": "string",
"description": "Hashing algorithm to use for the key.",
"title": "Hashing Algorithm"
},
"serial_number": {
"default": 1,
"type": "integer",
"description": "Serial number for the certificate.",
"title": "Serial Number"
},
"generation_date": {
"readonly": true,
"type": "string",
"description": "The date and time when the certificate was generated. Ignored when \"Generate Certificate Signing Request\" is true.",
"title": "Generated On"
},
"certificate_info": {
"properties": {
"city": {
"required": true,
"type": "string",
"description": "Name of the city.",
"title": "City"
},
"organization_unit": {
"required": true,
"type": "string",
"description": "A unit at the organization. For example, a department of a company.",
"title": "Organization Unit"
},
"state": {
"required": true,
"type": "string",
"description": "Name of the state.",
"title": "State"
},
"country_code": {
"maxLength": 2,
"required": true,
"type": "string",
"description": "Two letter description of the country.",
"title": "Country Code"
},
"common_name": {
"required": true,
"type": "string",
"description": "Must match the host being authenticated.",
"title": "Common Name"
},
"organization": {
"required": true,
"type": "string",
"description": "For example, a company name.",
"title": "Organization"
}
},
"required": true,
"type": "object",
"description": "Contains information about the certificate.",
"title": "Certificate Information"
},
"key_length": {
"default": 1024,
"type": "integer",
"description": "Length of the key to be generated.",
"title": "Key Length"
},
"description": {
"required": true,
"type": "string",
"description": "Documents the purpose of this certificate.",
"title": "Description"
}
},
"schema_version": "0.1.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Certificate/add/ |
|
The GUI Add form of data/Certificate as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/Certificate/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/Certificate/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Certificate/[pkid1]", "/api/data/Certificate/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Certificate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Certificate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Certificate/export/ |
|
{ "hrefs":["/api/data/Certificate/[pkid1]", "/api/data/Certificate/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/Certificate and the JSON format can be used to import instances of data/Certificate.
GET http://[host-proxy]/api/data/Certificate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Certificate | POST | /api/data/Certificate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/Certificate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/Certificate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/Certificate/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Certificate/ |
|
The data/Certificate schema and all instances as JSON. |
(The list will return 0 to 3 data/Certificate instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/Certificate/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/Certificate/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Certificate/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Certificate/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/Certificate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/Certificate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/Certificate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/Certificate/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/Certificate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Certificate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/Certificate",
"model_specific_actions": [
"clone",
"add",
"configuration_template",
"field_display_policy",
"export",
"export_bulkload_template",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update",
"upload_signed_certificate",
"export_certificate_request"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6109c97be04a4a00149f40a5",
"meta": {
"tags": [],
"cached": true,
"title": "SSO-Cert",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c97be04a4a00149f40a5",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/"
}
],
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/help",
"method": "GET",
"title": "Help"
}
},
{
"export_certificate_request": {
"target": "_blank",
"title": "Export Certificate Request",
"support_async": false,
"class": "custom",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+export_certificate_request/",
"method": "GET"
}
},
{
"upload_signed_certificate": {
"title": "Upload Signed Certificate",
"support_async": true,
"submit": "payload",
"class": "import",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+upload_signed_certificate/",
"method": "POST",
"view": "/api/view/FileUpload/add/"
}
}
],
"model_type": "data/Certificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109c97be04a4a00149f40a5"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"valid_from": 0,
"description": "Single Sign On Certificate",
"pkid": "6109c98fe04a4a00149f40a8",
"valid_to": 315360000,
"name": "SSO-Cert",
"expiry_date": "2031-08-01T22:55:55Z",
"hash_algorithm": "sha256",
"serial_number": 1,
"generation_date": "2021-08-03 22:55:55.896865 (UTC)",
"certificate_info": {
"city": "Cape Town",
"organization_unit": "QA",
"state": "WC",
"country_code": "ZA",
"common_name": "SSO_Certificate",
"organization": "Engineering"
},
"hierarchy_friendly_name": "hcs (Hcs)",
"key_length": 1024,
"hierarchy_path": "sys.hcs"
}
}
]
}
(Show the first instance)
{
"pkid": "6109c97be04a4a00149f40a5",
"meta": {
"tags": [],
"cached": false,
"title": "SSO-Cert",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "0.1.2",
"references": {
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"self": [
{
"pkid": "6109c97be04a4a00149f40a5",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"export_certificate_request": {
"target": "_blank",
"title": "Export Certificate Request",
"support_async": false,
"class": "custom",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+export_certificate_request/?hierarchy=[hierarchy]",
"method": "GET"
}
},
{
"upload_signed_certificate": {
"title": "Upload Signed Certificate",
"support_async": true,
"submit": "payload",
"class": "import",
"href": "/api/data/Certificate/6109c97be04a4a00149f40a5/+upload_signed_certificate/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/FileUpload/add/?auth_token=[authtoken]
}
}
],
"model_type": "data/Certificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109c97be04a4a00149f40a5"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"valid_from": 0,
"description": "Single Sign On Certificate",
"pkid": "6109c98fe04a4a00149f40a8",
"valid_to": 315360000,
"expiry_date": "2031-08-01T22:55:55Z",
"hash_algorithm": "sha256",
"serial_number": 1,
"generation_date": "2021-08-03 22:55:55.896865 (UTC)",
"certificate_info": {
"city": "Cape Town",
"organization_unit": "QA",
"state": "WC",
"country_code": "ZA",
"common_name": "SSO_Certificate",
"organization": "Engineering"
},
"key_length": 1024,
"name": "SSO-Cert"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Certificate. | GET | /api/data/Certificate/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Certificate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Certificate/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Certificate/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Certificate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Certificate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/Certificate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Certificate/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/Certificate and the JSON format can be used to import instances of data/Certificate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Certificate/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Certificate/[pkid]/ | hierarchy=[hierarchy] | The data/Certificate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Certificate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Certificate. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Export Certificate Request | GET | /api/data/Certificate/[pkid]/+export_certificate_request/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Upload Signed Certificate | POST | /api/data/Certificate/[pkid]/+upload_signed_certificate/ | hierarchy=[hierarchy] | If payload required: |