openapi: 3.2.0 info: title: Trust Protection Foundation WebSDK Metadata APIs API description: '# Introduction The Trust Protection Foundation Web SDK is a subset of REST APIs that allow you to: * Automate certificate management * Integrate with DevOps processes * Discover machine identities * Extract data to integrate with data warehouses * Perform bulk actions * Set up and administer Trust Protection Foundation * Onboard teams * Create custom, automated business logic and flows between internal systems All these use cases can be accomplished using the Trust Protection Foundation REST…' version: 26.1.1 servers: - url: / description: Current Host - url: https://REPLACEdnsnameME/ description: System - url: https://{dnsname}/ description: Configurable Hostname variables: dnsname: default: localhost description: Production API Hostname security: - AccessToken: [] tags: - name: Metadata APIs description: '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.' paths: /vedsdk/metadata/defineitem: post: tags: - Metadata APIs summary: Create a Custom Field description: 'Creates a new Custom Field. The Custom Field appears in the User Interface (UI). _Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_MetadataRest_DefineItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_defineitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_defineitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/updateitem: post: tags: - Metadata APIs summary: Update a Custom Field description: '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. **NOTE** You cannot update `SchemaAttribute`, `DN`, `GUID`, `Name` and `Type`. These properties are read-only after creation of the Custom Field. If you attempt to change them, the request will fail. _Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_MetadataRest_UpdateItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_updateitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_updateitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/undefineitem: post: tags: - Metadata APIs summary: Delete a Custom Field description: 'Removes an existing Custom Field. The caller must have Delete permission to the Custom Field object. _Required scope: configuration:delete_' operationId: Venafi_Core_WebSDK_MetadataRest_UndefineItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_undefineitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_undefineitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/items: get: tags: - Metadata APIs summary: Get all Custom Fields description: 'Returns every Custom Field definition. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_GetAllItems responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_items' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/finditem: post: tags: - Metadata APIs summary: Find a Custom Field description: 'Finds a Custom Field, searching by Name or UI label. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_FindItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_finditem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_finditem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/loaditem: post: tags: - Metadata APIs summary: Get Custom Field definition description: 'Returns a Custom Field definition. Unlike `POST metadata/loaditemguid`, this returns the full Custom Field definition. _Required scope: configuration_' operationId: Venafi_Core_WebSDK_MetadataRest_LoadItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_loaditem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_loaditem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/loaditemguid: post: tags: - Metadata APIs summary: Get Custom Field GUID description: 'Returns an Custom Field GUID. Unlike `POST metadata/loaditem`, this returns only the Custom Field GUID. _Required scope: configuration_' operationId: Venafi_Core_WebSDK_MetadataRest_LoadItemGuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_loaditemguid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_loaditemguid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/get: post: tags: - Metadata APIs summary: Read values description: '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. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_Get requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_get' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_get' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/readeffectivevalues: post: tags: - Metadata APIs summary: Read effective value description: 'Returns the effective value of a Custom Field for a particular object. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_ReadEffective requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_readeffectivevalues' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_readeffectivevalues' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/readpolicy: post: tags: - Metadata APIs summary: Read policy value description: 'Returns a Custom Field value that has been applied to a policy for inheritance by objects of a specific type. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_ReadPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_readpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_readpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/set: post: tags: - Metadata APIs summary: Write value description: 'Assigns a Custom Field value to an object. The caller must have Write permission to the DN of a certificate or device DN in the request _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_Set requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_set' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_set' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/setpolicy: post: tags: - Metadata APIs summary: Write policy value description: 'Assigns a Custom Field value to a policy. _Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_MetadataRest_SetPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_setpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_setpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/find: post: tags: - Metadata APIs summary: Search objects description: 'Returns all objects with a value stored for a Custom Field. At least one of _ItemGuid_ or _Value_ must be provided." _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_Find requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_find' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_find' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitems: post: tags: - Metadata APIs summary: Get applicable Custom Fields description: 'Returns an array of Custom Field attributes that apply to the specified object. Unlike `POST metadata/getitemguids`, this returns the full Custom Field definitions. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_GetItems requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitems' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitems' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitemguids: post: tags: - Metadata APIs summary: Get applicable Custom Field GUIDs description: '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. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_GetItemGuids requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitemguids' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitemguids' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getpolicyitems: post: tags: - Metadata APIs summary: Get allowed Custom Fields description: 'Returns all Custom Fields that are applicable to children of the specified container _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_GetPolicyItems requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getpolicyitems' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getpolicyitems' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitemsforclass: post: tags: - Metadata APIs summary: Get Custom Fields for class description: 'Returns an array of Custom Fields and their attributes that apply to the specified object class. _Required scope: :manage_' operationId: Venafi_Core_WebSDK_MetadataRest_GetItemsForClass requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitemsforclass' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitemsforclass' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] components: schemas: Core_WebSDK_MetadataWebResponse_getpolicyitems: type: object properties: PolicyItems: type: object additionalProperties: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields applicable to children of the object. description: "_This property is a dictionary._ \nkey1: value1 \nkey2: value2 \n..." Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_readpolicy: type: object properties: Values: type: array items: type: string description: The values stored for the Custom Field Locked: type: boolean description: 'The Policy status: * **true**: The Policy value, which applies to the Custom Field, is locked. * **false**: The Policy value for the Custom Field can be overridden at the object level.' Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_set: required: - DN - GuidData - KeepExisting type: object properties: DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response. GuidData: type: array items: type: object properties: ItemGuid: type: string description: The GUID that identifies the Custom Field. To get the Custom Field GUID, use POST Metadata/GetItems. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, _{3d6b61d-1c71-4603-883f-25b8c2ceecdd}_. List: type: array items: type: string description: An array of one or more Custom Field value changes. The value must match a Metadata Field Type. For example, to set a date, use the MM/DD/YYYY format. description: Support class to allow serialization of values for a metadata object description: An array of ItemGuid-List pairs that apply to the DN. Each pair uniquely identifies a Custom Field and the new value(s). If _GuidData_ is empty and _KeepExisting_ is **false** or not specified, every Custom Field for the DN resets to null. KeepExisting: type: boolean description: 'The flag to control Custom Field updates: * **true**: Update only the Custom Fields based on _GuidData_ values. All other Custom Fields for the DN remain unchanged. * **false**: Default. Clear all Custom Fields for the DN, and then set only the Custom Field values based on _GuidData_. If _GuidData_ is empty, all fields reset to **null**. **WARNING**: To retain existing Custom Field values, be sure to set _KeepExisting_ to true. Otherwise, the values for any Custom Fields of the DN, which are absent in the _GuidData_, will be cleared._' Core_WebSDK_MetadataWebResponse_readeffectivevalues: type: object properties: Values: type: array items: type: string description: The values stored for the Custom Field Overridden: type: boolean description: '* **true**: The Policy value was overridden by the value set on the object itself. * **false**: The suggested Policy value was used.' Locked: type: boolean description: 'The Policy status: * **true**: The Policy value, which applies to the Custom Field, is locked. * **false**: The Policy value for the Custom Field can be overridden at the object level.' PolicyDn: type: string description: DN of the policy where values are set Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_finditem: type: object properties: ItemGuid: type: string description: The GUID of the matching Custom Field, if a match was found Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_getitemguids: required: - DN type: object properties: DN: type: string description: The DN of a Certificate or Device object to look up. Core_WebSDK_MetadataWebResponse_get: type: object properties: GuidData: type: object additionalProperties: type: array items: type: string description: Values stored for the Custom Field on the object description: 'A dictionary of every Custom Field value for an object. **Key**: GUID of the Custom Field definition' Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_defineitem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The newly created metadata item (Custom Field) definition. DN: type: string description: The DN of the newly created Custom Field definition Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_setpolicy: required: - DN - SchemaClass - Locked - GuidData type: object properties: DN: type: string description: The DN of a policy folder that has values for at least one Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response. SchemaClass: type: string description: The Device or X509 Certificate class. (_Pre-24.1 this parameter was named ConfigClass_) Locked: type: boolean description: Boolean indicating whether the value is to be locked by policy. If not specified, the value will not be locked by policy. GuidData: type: array items: type: object properties: ItemGuid: type: string description: The GUID that identifies the Custom Field. To get the Custom Field GUID, use POST Metadata/GetItems. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, _{3d6b61d-1c71-4603-883f-25b8c2ceecdd}_. List: type: array items: type: string description: An array of one or more Custom Field value changes. The value must match a Metadata Field Type. For example, to set a date, use the MM/DD/YYYY format. description: Support class to allow serialization of values for a metadata object description: An array of ItemGuid-List pairs that apply to the DN. Each pair uniquely identifies a Custom Field and the new value(s). If _GuidData_ is empty and _KeepExisting_ is **false** or not specified, every Custom Field for the DN resets to null. Core_WebSDK_MetadataWebResponse_loaditemguid: type: object properties: ItemGuid: type: string description: The GUID of the Custom Field Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_get: required: - DN type: object properties: DN: type: string description: The DN of a certificate or device. All: type: boolean description: Boolean indicating that all Custom Fields that apply to this object should be returned, even if no values exist for them. Core_WebSDK_MetadataWebResponse_loaditem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The metadata item (Custom Field) definition Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_undefineitem: required: - ItemGuid type: object properties: ItemGuid: type: string description: The GUID of the Custom Field to delete. RemoveData: type: boolean description: 'Boolean indicating if existing values should be deleted when the Custom Field is deleted: * **true**: Delete existing values stored for the Custom Field before deleting the Custom Field itself. * **false**: Default. Do not delete any stored values. If values exist, the delete of the Custom Field will fail.' Core_WebSDK_MetadataWebRequest_getitems: required: - DN type: object properties: DN: type: string description: The DN of a Certificate or Device object to look up. Core_WebSDK_MetadataWebResponse_getitemguids: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields GUIDs applicable the the specified object. Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_updateitem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The new definition of the Custom Field. Include every setting that you want to retain or change. To reset every Custom Field setting, specify only the DN and the Guid. If the request omits an attribute, the value reverts to the default. Update: type: object description: The values to change for the Custom Field. Only provide properties you want to change, all other settings will be retained. Core_MetadataResult: title: Metadata API result codes enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 type: integer description: "\n\n**0**: **Success** \nSuccess\n\n**1**: **InvalidConfigObject** \nAn invalid or **null**_Config_ object was passed\n\n**2**: **InvalidDN** \nA **null** or empty DN string was passed\n\n**3**: **InvalidName** \nA **null** or empty Name string was passed\n\n**4**: **InvalidItem** \nThe _MetadataObject_ object was invalid or incomplete\n\n**5**: **InvalidClass** \nThe _SchemaClass_ object was invalid or incomplete\n\n**6**: **InvalidMetadataObject** \nThe _MetadataObject_ object was invalid or incomplete\n\n**7**: **InvalidRights** \nThe rights were invalid to perform the requested operation\n\n**8**: **ItemIsNull** \nA **null**_MetadataObject_ was passed\n\n**9**: **ItemAlreadyExists** \nA _MetadataObject_ object with the same name or label already exists\n\n**10**: **ItemTypeUnknown** \nThe type of _MetadataObject_ object is not supported\n\n**11**: **ConfigCreateFailed** \nThe metadata storage failed to create the object\n\n**12**: **ConfigWriteFailed** \nThe metadata storage failed when updating the object\n\n**13**: **ConfigDeleteFailed** \nThe metadata storage failed when deleting the object\n\n**14**: **MetadataInUse** \nThe metadata item could not be deleted because it is still referenced on objects\n\n**15**: **NoAllowedValues** \nThe Metadata item has no allowed values\n\n**16**: **AllowedValueDoesNotExist** \nThe specified 'allowed' value does not exist\n\n**17**: **ValueNotInAllowedList** \nThe provided value is not in the list of allowed values\n\n**18**: **ItemNotValidForClass** \nThe specified metadata item is not valid for the object class\n\n**19**: **NameTooLong** \nThe name for the metadata item is longer than allowed (255 chars, including its parents)\n\n**20**: **TooManyContainers** \nThe name for the metadata is nested deeper than allowed\n\n**21**: **ConfigDnNotContainer** \nPassed DN was expected to be a container\n\n**22**: **InvalidPolicyState** \nCannot write a policy with the specified policy state\n\n**23**: **ConfigLockFailed** \nFailed to acquire a config lock\n\n**24**: **ConfigReadFailed** \nFailed to read data from config\n\n**25**: **RemoteError** \nA remote request failed; see Error property for details\n\n**26**: **ValueDoesNotMatchRegex** \nThe value supplied does not match the regex pattern which is configured for this metadata type\n\n**27**: **ArgumentIsNull** \nA required argument was null\n\n**28**: **TransientAttributeUnknown** \nThe schema attribute matching the metadata item is missing\n\n**29**: **BusError** \nA bus-related unspecified error\n" format: int32 Core_WebSDK_MetadataWebRequest_finditem: required: - Name type: object properties: Name: type: string description: The label or name of the Custom Field to find. Core_WebSDK_MetadataWebRequest_loaditem: required: - DN type: object properties: DN: type: string description: The DN of the Custom Field to return. Core_MetadataType: title: Enumeration of possible metadata types enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\n\n**0**: **Unknown** \nUnknown\n\n**1**: **Text** \nText input field\n\n**2**: **List** \nList selection\n\n**3**: **Choice** \nSingle/Multiple choice\n\n**4**: **DateTime** \nDate/Time picker\n\n**5**: **Identity** \nIdentity selector\n\n**6**: **DNReference** \nDN\n\n**7**: **Integer** \nInteger\n\n**8**: **Boolean** \nBoolean\n" format: int32 Core_WebSDK_MetadataWebResponse_undefineitem: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_find: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: - integer - 'null' description: The unique ID of this object. format: int64 Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: 'The revision of this object. Revisions are updated with each change, and, in case of a container, if a subordinate object is added or deleted.' format: int64 description: The CyberArk storage system for object referencing. description: The list of objects that have a matching Custom Field value Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_readpolicy: required: - ItemGuid - DN - Type type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. To get the GUIDs for a DN, use `POST Medata/GetItemGuids`. DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. Type: type: string description: The class type to read policy for Core_WebSDK_MetadataWebRequest_find: type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. If provided, only values of this Custom Field are searched Value: type: string description: The value a stored Custom Field value must match. Web_SDK_Authentication_OAuthError: type: object properties: error: type: string description: Gets or sets the short error name error_description: type: string description: Gets or sets the description of the error description: REST OAuth Error Response Core_WebSDK_MetadataWebRequest_getitemsforclass: required: - SchemaClass type: object properties: SchemaClass: type: string description: "An object class (_Pre-24.1 this parameter was named `ConfigClass`_)\n\nCommon object classes are: \n* `Code Signing Environment Base`: Show the Custom Fields for Code Signing Project Environments\n* `Code Signing Project`: Show the Custom Fields for Code Signing Projects \n* `Device`: Show the Custom Fields for Devices\n* `X509 Certificate`: Show the Custom Fields for Certificates" Core_WebSDK_MetadataWebResponse_set: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_defineitem: required: - Item type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: A metadata item that represents the Custom Field to be created. A Custom Field requires, at a minimum, the `Label`, `Name`, `Classes` and `Type` properties. Core_WebSDK_MetadataWebRequest_loaditemguid: required: - DN type: object properties: DN: type: string description: The DN of the Custom Field to return. Core_WebSDK_MetadataWebResponse_getitems: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields applicable the the specified object. Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_getitemsforclass: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields available to be set on the specified object class Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_readeffectivevalues: required: - ItemGuid - DN type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. To get the GUIDs for a DN, use `POST Medata/GetItemGuids`. DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. Core_WebSDK_MetadataWebResponse_updateitem: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_setpolicy: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Locked: type: boolean description: 'The Policy status: * **true**: The Policy value, which applies to the Custom Field, is locked. * **false**: The Policy value for the Custom Field can be overridden at the object level.' Core_WebSDK_MetadataWebRequest_getpolicyitems: required: - DN type: object properties: DN: type: string description: A container DN. Core_WebSDK_MetadataWebResponse_items: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: - integer - 'null' description: Gets or sets the minimum length of the text field. format: int32 MaximumLength: type: - integer - 'null' description: Gets or sets the maximum length of the text field. format: int32 Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: A list of all existing Custom Field definitions Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** securitySchemes: AccessToken: type: http scheme: bearer