The Metadata interface manages Custom Fields for objects that appear in the following places of the UI:
- Certificates
- Devices
- Code Signing Projects
- Code Signing Environments
Metadata Types
| Type | Name | Description |
|---|---|---|
| 1 | Text | Can accept a single line of text. MinimumLength, MaximumLength, Mask and RegularExpression apply to this field type |
| 2 | List | Provides the user with a list of selectable items. Single controls if one or more items can be selected |
| 3 | Choice | Provides the user with options. if Single is true, the options are presented as radio-buttons, otherwise they are checkboxes |
| 4 | Date | Provides the user with a date/time selector. DateOnly and TimeOnly apply to this field type |
| 5 | Identity | Provides the user with the ability to select an identity. If Single is true, only one identity can be selected |
Metadata Item (Custom Field Definition)
The Metadata Item describes a Custom Field.
| Property name | Data Type | Description |
|---|---|---|
| AllowedCharacters | string | Optional: All characters allowed in values |
| AllowedValues | [string] | Optional: An array of allowable values |
| Classes | [string] | An array of schema classes that can use the custom field |
| SchemaAttribute | string | Read-Only: The Custom Field GUID |
| DateOnly | boolean | For Date type Custom Fields: Only ask for date, hide time |
| DN | string | Read-Only: The DN of the Custom Field definition object |
| DefaultValues | [string] | Optional: An array of values used set by default on the CustomField |
| Guid | string | Read-Only: The Custom Field GUID |
| Help | string | Optional: The tool tip to show the user how to populate the Custom Field |
| Label | string | The text that describes the Custom Field in the UI |
| Mandatory | boolean | Optional: If true, users must enter a value for the Custom Field in the UI |
| Mask | string | Optional: An input mask to use for Text type Custom Fields. The '#'-character represents characters the user may provide |
| MaximumLength | nullable integer | Optional: The maximum number of characters a user can input for the Custom Field that accepts a string |
| MinimumLength | nullable integer | Optional: The minimum number of characters a user must input for the Custom field that accepts a string |
| Name | string | The name (CN) of the Custom Field. Required for POST metadata/defineitem, read-only otherwise |
| Policyable | boolean | Optional: If true, policy will be applied to a Custom Field |
| RegularExpression | string | Optional: The regular expression to apply to user input in a Text type Custom Field |
| RenderHidden | boolean | Optional: If true, the UI will not display the Custom Field |
| RenderReadOnly | boolean | Optional: If true, the UI will display the Custom Field but not let the user change it |
| Single | boolean | Optional: If true, only a single value can be selected for a List or Choice type Custom Field |
| TimeOnly | boolean | Optional: If true, only a time can be entered in a Date type Custom Field |
| Type | integer | The type of the Custom Field. Required for Post metadata/defineitem, read-only otherwise |
📄️ Create a Custom Field
Creates a new Custom Field. The Custom Field appears in the User Interface (UI).
📄️ Update a Custom Field
Updates settings that control a Custom Field, such as default and required user input values. Either the _Item_ or _Update_ property must be provided, but **not** both.
📄️ Delete a Custom Field
Removes an existing Custom Field. The caller must have Delete permission to the Custom Field object.
📄️ Get all Custom Fields
Returns every Custom Field definition.
📄️ Find a Custom Field
Finds a Custom Field, searching by Name or UI label.
📄️ Get Custom Field definition
Returns a Custom Field definition. Unlike `POST metadata/loaditemguid`, this returns the full Custom Field definition.
📄️ Get Custom Field GUID
Returns an Custom Field GUID. Unlike `POST metadata/loaditem`, this returns only the Custom Field GUID.
📄️ Read values
Returns the values for all Custom Fields that apply to a particular object. The caller must have Read permission to the DN of a certificate or device in the request.
📄️ Read effective value
Returns the effective value of a Custom Field for a particular object.
📄️ Read policy value
Returns a Custom Field value that has been applied to a policy for inheritance by objects of a specific type.
📄️ Write value
Assigns a Custom Field value to an object.
📄️ Write policy value
Assigns a Custom Field value to a policy.
📄️ Search objects
Returns all objects with a value stored for a Custom Field. At least one of _ItemGuid_ or _Value_ must be provided.'
📄️ Get applicable Custom Fields
Returns an array of Custom Field attributes that apply to the specified object. Unlike `POST metadata/getitemguids`, this returns the full Custom Field definitions.
📄️ Get applicable Custom Field GUIDs
Returns an array of Custom Field GUIDs for that apply to the specified object. Unlike `POST metadata/getitems`, this returns only the GUID of the each Custom Field.
📄️ Get allowed Custom Fields
Returns all Custom Fields that are applicable to children of the specified container
📄️ Get Custom Fields for class
Returns an array of Custom Fields and their attributes that apply to the specified object class.