Common Response Objects

This page contains fields that are used in APIs for add, update, and get certificate attributes. These fields are grouped together here because they are common to these APIs.

Table 1. Parameters for CertificateGenericField
Name Description
_id Unique identifier for the attribute.

Type: String

name Name of the attribute.

Type: String

type Type of the attribute.

Type: String

value Default value for the attribute.

Type: String

label Label to be shown in the UI for the custom attribute.

Type: String

searchKey Keyword for searching the certificate based on the attribute.

Type: String

mandatory Indicates whether the attribute is mandatory or optional.

Type: Boolean

category The category of the attribute will always be "certAttributes" for certificate attributes.

Type: String

helpInfo Help information about the field.

Type: String