Metadata Item

The Metadata Item controls the visibility and use of a Custom Field.

  • Attribute names are not case sensitive. For example, you can specify renderhidden instead of RenderHidden.
  • Custom Fields hide or appear in the UI Works with the Classes and RenderHidden settings.
  • If the value is null, a Metadata API response omits this attribute from the return value of an API call.
Metadata Item attributes

Attribute name

Datatype

Description

AllowedCharacters

String

 (Optional) A set of Base 64 encoded strings.

AllowedValues

String

 (Optional) An array of allowable values for the Custom Field.

Category

String

(Optional) A Distinguished Name (DN) of the item category or null if no category.

Classes

String

Required. An array of certificate classes that use the Custom Field:

  • Code Signing Environment Base: Works with RenderHidden. Show the Custom Field on the Project Environments tab.

  • Code Signing Project: Works with RenderHidden. Show the Custom Field on the Code signing Project page.

  • Device: Works with RenderHidden. Show the Custom Field on the Device Settings tab and the Device details page.
  • Policy:  Works with RenderHidden. Show the Custom Field in the Policy.
  • X509 Certificate: Works with RenderHidden. Show the Custom Field on the Certificate Settings tab and the Certificate details.

ConfigAttribute

String

(Optional) For POST Metadata/UpdateItem is read-only. The Custom Field GUID.

DateOnly

 Boolean

(Optional) The setting controls whether the Custom Field requires a calendar date. On a REST API response, this field only appears with dates (Type 4) :

  • true: The calendar date is required for the Custom Field.

DN

 String For Metadata/UpdateItem, this attribute is read-only. The Distinguished Name (DN) of the Custom Field.

DefaultValues

 String

(Optional) An array of one or more default values that appear to the user. On a REST Response, if there is not default, the field is either omitted or an empty array.

DisplayAfter

 String (Optional) The Custom Field appears after an array of Custom Field values.

ErrorMessage

 String (Optional) The error message that you define for this Custom Field.

Guid

 String (Optional) For POST Metadata/UpdateItem is read-only. The Custom Field GUID.

Help

 String (Optional) The tool tip to show to the user how to populate the Custom Field.

Label

 String

Required. The text that describes the Custom Field in the UI.

LocalizationTable

String

(Optional) An array or dictionary of strings from another language.

LocalizedHelp

String

(Optional) The localized help text that describes the Custom Field.

LocalizedLabel

String

(Optional) A localized label text describing the Custom Field.

LocalizedSet

 String

(Optional) An array of localization settings. Language: The culture code.

List: An array of Invarient and corresponding Localized string for each AllowedValues element.

Mandatory

Boolean

(Optional) If present, a Custom Field value is required.

  • true: The user is required to supply a value for the Custom Field.

Mask

String

(Optional) The set of characters to use to hide user input for the Custom Field.

MaximumLength

Nullable integer

(Optional) The Default is null. The maximum number of characters a user can input for the Custom Field that accepts a string.

MinimumLength

Nullable integer

(Optional) The Default is null. The minimum number of characters a user can input for Custom Field that accepts a string.

Name

 String Required. The Custom Field name or GUID. For POST Metadata/UpdateItem is read-only.

Policyable

Boolean

(Optional) The setting to determine whether a policy applies to the Custom Field:

  • false: Default. Disallow a Policy from applying to a Custom Field.
  • true: Default. Allow a Policy to apply to the Custom Field.

RegularExpression

String

 (Optional) The regular expression to control user input. For example: ^[a-zA-Z0-9_\\.\\+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-\\.]+$.

RenderHidden

Boolean

(Optional) The setting to control visibility of the Custom field in the UI:

  • false : Default. Show the Custom Field in the UI. Works in conjunction with Classes and Label. For example if Classes has a value of X509 Certificate, your Custom Field appears on the Certificate Settings tab and the Certificate details page.
  • true: Hide the Custom Field in the UI.

RenderReadOnly

Boolean

(Optional) The setting to control UI changes:

  • false: Default. If the Custom Field is present in the UI, a user can change the value.
  • true: The Custom Field is immutable.

Single

Boolean

The setting to control the number of input selections:

  • false: Default. The user can select multiple values for the Custom Field.
  • true: The user can select only one value for the Custom Field.

TimeOnly

Boolean

(Optional) The setting controls whether the Custom Field requires a time of day:

  • false: Default. The time of day is optional for the Custom Field.
  • true: The time of day is required for the Custom Field.

Type

Integer
  • Required. The Metadata Field Type that describes the UI element for this Custom Field. For POST Metadata/UpdateItem this attribute is read-only.