openapi: 3.2.0 info: title: Trust Protection Foundation WebSDK Configuration 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: Configuration APIs description: '## Introduction ## The Config interface manages objects, attributes, and policy values. API responses include a `Result` value that describes the result of the API call. If an operation failed, the API call returns an additional `Error` field that describes the cause of the error' paths: /vedsdk/config/enumerate: post: tags: - Configuration APIs summary: Search objects description: 'Returns a list of all subordinate Config objects for a specified folder _Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsFilteredRecursive requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerate' '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/config/enumerateall: post: tags: - Configuration APIs summary: Enumerate objects description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateAllObjects requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerateall' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerateall' '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/config/enumeratepolicies: post: tags: - Configuration APIs summary: Enumerate policies description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_EnumeratePolicies requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumeratepolicies' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumeratepolicies' '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/config/enumerateobjectsderivedfrom: post: tags: - Configuration APIs summary: Enumerate derived objects description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsDerivedFrom requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerateobjectsderivedfrom' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerateobjectsderivedfrom' '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/config/create: post: tags: - Configuration APIs summary: Create an object description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_CreateObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_create' '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/config/delete: post: tags: - Configuration APIs summary: Delete an object description: '_Required scope: configuration:delete_' operationId: Venafi_Core_WebSDK_ConfigRest_DeleteObjectRecursive requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_delete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_delete' '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/config/defaultdn: get: tags: - Configuration APIs summary: Gets the default DN description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_DefaultDN responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_defaultdn' '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/config/find: post: tags: - Configuration APIs summary: Search an object by attribute description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_FindByAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_find' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_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/config/readall: post: tags: - Configuration APIs summary: Read all attributes description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ReadAllAttributes requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readall' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readall' '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/config/findcontainers: post: tags: - Configuration APIs summary: Search containers description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_FindContainer requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findcontainers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findcontainers' '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/config/findobjectsofclass: post: tags: - Configuration APIs summary: Search objects of class description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_FindObjectsOfClass requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findobjectsofclass' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findobjectsofclass' '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/config/findpolicy: post: tags: - Configuration APIs summary: Search policies description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_FindPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findpolicy' '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/config/gethighestrevision: post: tags: - Configuration APIs summary: Get highest container revision description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_GetHighestRevision requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_gethighestrevision' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_gethighestrevision' '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/config/getrevision: post: tags: - Configuration APIs summary: Get object revision description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_GetRevision requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_getrevision' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_getrevision' '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/config/getobjecttrustees: post: tags: - Configuration APIs summary: Get trustees of object description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_GetObjectTrustees requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_getobjecttrustees' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_getobjecttrustees' '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/config/guidtodn: post: tags: - Configuration APIs summary: Convert GUID to DN description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_GUIDtoDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_guidtodn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_guidtodn' '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/config/isvalid: post: tags: - Configuration APIs summary: Check if object exists description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_IsValid requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_isvalid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_isvalid' '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/config/mutateobject: post: tags: - Configuration APIs summary: Change object class description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_MutateObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_mutateobject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_mutateobject' '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/config/containableclasses: post: tags: - Configuration APIs summary: Enumerate container classes description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ContainableClasses requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_containableclasses' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_containableclasses' '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/config/dntoguid: post: tags: - Configuration APIs summary: Convert DN to GUID description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_DNToGUID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_dntoguid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_dntoguid' '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/config/idinfo: post: tags: - Configuration APIs summary: Convert ID to DN description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_IDToDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_idinfo' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_idinfo' '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/config/renameobject: post: tags: - Configuration APIs summary: Rename an object description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_RenameObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_renameobject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_renameobject' '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/config/clearattribute: post: tags: - Configuration APIs summary: Remove an attribute description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_ClearAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_clearattribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_clearattribute' '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/config/clearpolicyattribute: post: tags: - Configuration APIs summary: Remove a policy attribute description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_ClearPolicyAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_clearpolicyattribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_clearpolicyattribute' '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/config/read: post: tags: - Configuration APIs summary: Read an attribute description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_Read requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_read' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_read' '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/config/countobjects: post: tags: - Configuration APIs summary: Return number of objects description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_CountObjects requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_countobjects' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigCountWebResponse' '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/config/readdn: post: tags: - Configuration APIs summary: Read a DN attribute description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ReadDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readdn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readdn' '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/config/readdnreferences: post: tags: - Configuration APIs summary: Find all objects referencing a DN description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ReadDNReferences requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readdnreferences' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readdnreferences' '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/config/readeffectivepolicy: post: tags: - Configuration APIs summary: Read effective attribute description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ReadEffectivePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readeffectivepolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readeffectivepolicy' '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/config/readpolicy: post: tags: - Configuration APIs summary: Read policy attribute description: '_Required scope: configuration_' operationId: Venafi_Core_WebSDK_ConfigRest_ReadPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_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/config/addvalue: post: tags: - Configuration APIs summary: Add attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_AddValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_addvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_addvalue' '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/config/adddnvalue: post: tags: - Configuration APIs summary: Add DN attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_AddDNValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_adddnvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_adddnvalue' '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/config/addpolicyvalue: post: tags: - Configuration APIs summary: Add policy attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_AddPolicyValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_addpolicyvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_addpolicyvalue' '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/config/removevalue: post: tags: - Configuration APIs summary: Remove attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_RemoveValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removevalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removevalue' '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/config/removednvalue: post: tags: - Configuration APIs summary: Remove DN attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_RemoveDNValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removednvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removednvalue' '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/config/removepolicyvalue: post: tags: - Configuration APIs summary: Remove policy attribute value description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_RemovePolicyValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removepolicyvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removepolicyvalue' '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/config/write: post: tags: - Configuration APIs summary: Write attributes description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_Write requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_write' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_write' '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/config/writedn: post: tags: - Configuration APIs summary: Write DN attributes description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_WriteDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_writedn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_writedn' '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/config/writepolicy: post: tags: - Configuration APIs summary: Write policy attributes description: '_Required scope: configuration:manage_' operationId: Venafi_Core_WebSDK_ConfigRest_WritePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_writepolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_writepolicy' '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/configschema/classes: post: tags: - Configuration APIs summary: Get class definitions description: '_Required scope: Any_' operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Classes requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_classes' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_classes' '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/configschema/class: post: tags: - Configuration APIs summary: Get a class definition description: '_Required scope: Any_' operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Class requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_class' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_class' '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/configschema/attributes: post: tags: - Configuration APIs summary: Get attributes description: '_Required scope: Any_' operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Attribues requestBody: content: application/json: schema: type: - object - 'null' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_attributes' '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/configschema/attribute: post: tags: - Configuration APIs summary: Get an attribute description: '_Required scope: Any_' operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Attribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_attribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_attribute' '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_ConfigWebRequest_findobjectsofclass: type: object properties: ObjectDN: type: string description: The object dn. ObjectID: type: integer description: Gets or sets the object id. format: int64 Class: type: string description: The class. Classes: type: array items: type: string description: The classes. Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" Core_SchemaClass_Properties: title: Behavioural properties for schema classes enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 type: integer description: "\n\n**0**: **None** \nA default internal enumeration.\n\n**1**: **NonRemovable** \nObsolete\n\n**2**: **NonEffective** \nNo objects, of the schema class, can be created.\n\n**4**: **Container** \nObjects, of this schema class, can contain subordinate objects.\n\n**8**: **SelfContainment** \nObjects, of this schema class, can contain subordinate objects of this schema class.\n\n**16**: **SuperClass** \nThe associated schema class name is a super-class list entry for this schema class.\n\n**32**: **ContainedBy** \nThe associated schema class name is a contained by list entry for this schema class.\n\n**64**: **NamedBy** \nObsolete\n\n**128**: **Mandatory** \nThe associated schema attribute name is a mandatory list entry for this schema class.\n\n**256**: **Optional** \nThe associated schema attribute name is a optional list entry for this schema class.\n\n**512**: **ContainedBySub** \nThe associated schema class name is a super-class whose sub-classes can contain this schema class.\n\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\n" format: int32 Core_WebSDK_ConfigWebRequest_renameobject: required: - ObjectDN - NewObjectDN type: object properties: ObjectDN: type: string description: The object dn. NewObjectDN: type: string description: The new object DN. Core_WebSDK_ConfigWebResponse_getobjecttrustees: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigCountWebResponse: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Count: type: integer description: The count. format: int64 description: Response for a successful config request Core_WebSDK_ConfigWebRequest_clearattribute: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to clear. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to clear. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_readdnreferences: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_readall: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' NameValues: type: array items: type: object properties: Name: type: string description: The name. Values: type: array items: type: string description: The values. description: Class to pass when creating a new config object description: The name values. Error: type: string description: An error description, or **null**. Core_SchemaAttribute_Properties: title: Behavioural properties for schema attributes enum: - 0 - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 type: integer description: "\n\n**0**: **SingleValued** \nDefault\n\n**0**: **None** \nDefault\n\n**1**: **NonRemovable** \nObsolete\n\n**2**: **Hidden** \nObsolete\n\n**4**: **PublicRead** \nObsolete\n\n**8**: **ReadOnly** \nObsolete\n\n**16**: **MultiValued** \nValues, of this schema attribute, can have multiple values.\n\n**32**: **AlwaysWritable** \nObsolete\n\n**64**: **Transient** \nThis attribute is transient and can be removed while it is still in use\n\n**128**: **PolicyEnabled** \nValue can be overridden by policy\n\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\n" format: int32 Core_WebSDK_ConfigWebResponse_containableclasses: type: object properties: ClassNames: type: array items: type: string description: A list of schema class names. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_create: type: object properties: Object: 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: A `ConfigObject` item, describing an object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_create: required: - ObjectDN - Class type: object properties: ObjectDN: type: string description: The object dn. Class: type: string description: The class. NameAttributeList: type: object description: The name attribute list. Core_WebSDK_ConfigWebResponse_writedn: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_write: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to write. Only honored if ObjectID is not provided. AttributeData: type: object description: Gets or sets many attribute values AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Core_WebSDK_ConfigWebResponse_isvalid: type: object properties: Object: 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: A `ConfigObject` item, describing an object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_guidtodn: required: - ObjectGUID type: object properties: ObjectGUID: type: string description: The object GUID. Core_WebSDK_ConfigWebRequest_enumerateobjectsderivedfrom: required: - DerivedFrom type: object properties: DerivedFrom: type: string description: The derived from. Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebResponse_readpolicy: type: object properties: Values: type: array items: type: string description: A list of values. Locked: type: - boolean - 'null' description: '**true** if locked; otherwise, **false**.' Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readdnreferences: required: - AttributeName - ReferenceAttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. ReferenceAttributeName: type: string description: The name of the reference attribute. Core_WebSDK_ConfigWebSchemaRequest_classes: type: object properties: DerivedFrom: type: string description: The derived from class name. Core_WebSDK_ConfigWebResponse_getrevision: type: object properties: Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_classes: type: object properties: ClassDefinitions: type: array items: type: object properties: Id: type: integer description: The storage ID. format: int32 Property: $ref: '#/components/schemas/Core_SchemaClass_Properties' Name: type: string description: 'The name for this _SchemaClass_ object.' SuperClassNames: type: array items: type: string description: The super class names. ContainmentNames: type: array items: type: string description: The containment names. ContainmentSubNames: type: array items: type: string description: The containment sub names. OptionalNames: type: array items: type: string description: The optional names. OptionalNamesEx: type: array items: type: string description: The optional attribute names. SuperClassesExNames: type: array items: type: string description: The super class names. description: Class representing a schema class. description: A list of schema class definitions. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_ConfigResult: title: Error codes for Config methods enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 14 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 112 - 113 - 114 - 115 - 116 - 117 - 118 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 209 - 210 - 211 - 300 - 301 - 350 - 351 - 352 - 353 - 354 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 600 - 601 - 602 - 603 - 604 - 700 - 701 - 702 - 703 - 704 - 800 - 900 type: integer description: "\n\n**0**: **None** \n\n\n**1**: **Success** \nOperation completed successfully.\n\n**2**: **InvalidArgument** \nAn invalid method argument was passed to a method.\n\n**3**: **InvalidArgumentRange** \nAn argument value is not within the range accepted by a method.\n\n**4**: **MismatchedArguments** \nOne, or more, method argument counts do not match.\n\n**5**: **NotImplemented** \nThe method has not been implemented.\n\n**6**: **InvalidDestinationList** \nA method output argument list is invalid.\n\n**7**: **InsufficientPrivileges** \nThe method call has insufficient permissions to perform an operation.\n\n**8**: **InvalidOperation** \nA method call has been attempted using an invalid or disposed \ninstantiated **Config** object.\n\n**9**: **UnexpectedAssemblyError** \nAn unexpected error occurred within a called assembly.\n\n**10**: **OutOfMemory** \nAn operation failed due to insufficient system resources.\n\n**11**: **OperationCancelled** \nAn operation was cancelled.\n\n**14**: **RemoteError** \nA remote request failed; see Error property for details\n\n**100**: **AttributeDoesNotExist** \nThe request attribute does not exist.\n\n**101**: **AttributeAlreadyExists** \nThe attribute name already exists within the attribute schema, or, as an \noptional or mandatory attribute to a class.\n\n**102**: **AttributeNotFound** \nThe attribute was not within the attribute schema, or, was not found to \nhave a value for an object.\n\n**103**: **AttributeValueExists** \nA matching attribute value already exists for an object.\n\n**104**: **AttributeStillInUse** \nThe attribute cannot be removed from the attribute schema as the \nattribute is still in use by one, or more, objects.\n\n**105**: **AttributeNameTooLong** \nThe attribute cannot be defined as the attribute name exceeds the \nmaximum defined attribute name length.\n\n**106**: **AttributeReferenceDoesNotExist** \nAn attribute reference cannot be added to a schema class definition \nas the attribute does not exist within the attribute schema.\n\n**107**: **AttributeSyntaxCollision** \nThe attribute schema definition cannot be created as an attribute \nalready exists within the attribute schema with a different syntax.\n\n**108**: **AttributePropertyCollision** \nThe attribute schema definition cannot be created as an attribute \nalready exists within the attribute schema with conflicting attribute \nproperties.\n\n**109**: **CannotRemoveMandatory** \nThe attribute cannot be removed from an class schema definition as te \nattribute is a mandatory attribute value for the class.\n\n**110**: **AttributeValueIsMandatory** \nAn object cannot be created as an class mandatory attribute value has \nnot been set.\n\n**111**: **AttributeValueTooLong** \nAn attribute value cannot be written as the value of the attribute \nexceeds the maximum permitted value length.\n\n**112**: **IllegalAttributeForClass** \nAn attribute value cannot be written as the schema class definition \ndoes not define the attribute as being mandatory or optional.\n\n**113**: **InvalidAttributeDN** \nAn attribute value cannot be written as the object distinguished name, \ncontained within the attribute value, does not exist.\n\n**114**: **AttributeValueDoesNotExist** \nAn attribute value was not found on an object.\n\n**115**: **AttributeIsSingleValued** \nAn attribute value cannot be written as the attribute already has a \nvalue on an object and the attribute is defined as having only a single \nvalue.\n\n**116**: **AttributeIsReadOnly** \nAn attribute value cannot be written since it is marked as read-only.\n\n**117**: **AttributeIsHidden** \nAn attribute value cannot be written since it is marked as hidden.\n\n**118**: **AttributeValueInvalidFormat** \nAn attribute value has an invalid format.\n\n**200**: **ClassDoesNotExist** \nNo schema class definition exists with a matching name.\n\n**201**: **ClassAlreadyExists** \nA schema class definition already exists with that name.\n\n**202**: **ClassStillInUse** \nThe schema class definition cannot be removed from the schema as one, \nor more, objects of the class still exist.\n\n**203**: **ClassNameTooLong** \nThe schema class definition cannot be created as the name exceeds the \nmaximum name permitted for a schema class definition.\n\n**204**: **ClassInvalidSuperClass** \nThe schema class definition cannot be created due to the fact that one \nof the definitions super-classes do not exist.\n\n**205**: **ClassInvalidContainmentClass** \nThe schema class definition cannot be created due to the fact that one \nof the definitions contained by classes do not exist.\n\n**206**: **ClassInvalidNamingAttribute** \nThe schema class definition cannot be created due to the fact that one \nof the definitions naming attributes are not defined within the schema \nattribute definitions.\n\n**207**: **ClassInvalidMandatoryAttribute** \nThe schema class definition cannot be created due to the fact that one \nof the definitions mandatory attributes are not defined within the schema \nattribute definitions.\n\n**208**: **ClassInvalidOptionalAttribute** \nThe schema class definition cannot be created due to the fact that one \nof the definitions optional attributes are not defined within the schema \nattribute definitions.\n\n**209**: **ClassInvalidName** \nThe schema class definition cannot be created due to the fact that the \nclass name is an empty name.\n\n**210**: **ClassInvalidContainmentSubClass** \nThe schema class definition cannot be created due to the fact that one \nof the definitions contained by super-classes do not exist.\n\n**211**: **ClassInvalidStructure** \nThe schema class definitions cannot be loaded due to one, or more, \ninvalid class or attribute relations.\n\n**300**: **PolicyDoesNotExist** \nNo matching policy was found for the class and attribute combination \nfor the object.\n\n**301**: **PolicyLockStateCollision** \nAn existing policy was found for the class and attribute combination \nfor the object; however, the existing policy lock state does not match \nthe lock state of the policy being added.\n\n**350**: **LockNameAlreadyExists** \nAn existing lock was found for the name given in an new lock attempt.\n\n**351**: **LockNameDoesNotExist** \nThe specified name is not locked.\n\n**352**: **LockNameOwnedByAnother** \nThe specified name is locked by another owner.\n\n**353**: **LockNameLimitReached** \nThe specified name, or category, already has reached the specified \nconcurrent locks allowed limit.\n\n**354**: **LockNameAttemptTimedOut** \nThe specified name is locked by another owner; or, has reached the \nspecified concurrent locks allowed limit and could not be acquired \nwithint the specified timeout interval.\n\n**400**: **ObjectDoesNotExist** \nThe specified object does not exist.\n\n**401**: **ObjectAlreadyExists** \nAn object cannot be created as an object, with a matching name, already \nexists.\n\n**402**: **ObjectHasChildren** \nThe object cannot be deleted as the object has one, or more, subordinate \nchildren objects.\n\n**403**: **ObjectNameTooLong** \nThe object cannot be created as the object name exceeds the maximum \npermitted name length for an object.\n\n**404**: **ObjectDepthTooDeep** \nThe object cannot be created as the object hiearchical parent count \nexceeds the maximum object depth permitted.\n\n**405**: **ObjectInvalidName** \nThe object cannot be created due to the fact that the object name is \nempty.\n\n**406**: **ObjectInvalidClass** \nThe object cannot be created due to the fact that no schema class \ndefinition was found.\n\n**407**: **ObjectInvalidContainment** \nThe object cannot be created due to the fact that the parent object's \nschema class definition is not defined as a contained-by class within \nthe schema class definition.\n\n**408**: **ObjectMandatoryMissing** \nThe object cannot be created due to the fact that one, or more, \nmandatory attributes, as defined by the object's schema class definition \nwere not provided.\n\n**409**: **ObjectIsReadOnly** \nThe object cannot be modified.\n\n**410**: **ObjectInvalidOperation** \nThe operation not allowed on the object.\n\n**500**: **DriverMissingDSN** \nNo database connection information was found for a storage driver.\n\n**501**: **DriverMissingDatabaseName** \nThe database connection information does not define the storage driver's \ndatabase name.\n\n**502**: **DriverDatabaseError** \nAn error occurred between the storage driver and its database.\n\n**503**: **DriverTransactionError** \nA transaction error occurred during a write operation within a storage \ndriver.\n\n**504**: **DriverTransactionCollision** \nAn existing write operation between the storage driver and a database \nis already in progress.\n\n**505**: **DriverGenerationUpdateError** \nAn attempt to update the storage drivers schema generational qualifier \nfailed.\n\n**506**: **DriverStatementTimeout** \nA SQL statement execution timed out.\n\n**600**: **CacheLockException** \nAn operation cannot be completed as a schema cache lock management error \noccurred.\n\n**601**: **CacheEntryNotFound** \nNo matching entry name was found within a schema cache.\n\n**602**: **CacheEntryAlreadyExists** \nAn entry could not be added to a schema cache as an entry with a \nmatching name already exists.\n\n**603**: **CacheEntryIsSuperior** \nAn entry could not be added to the schema cache as an entry with \na matching name and definitions exist. However, the matching \nentry contains additional definitions.\n\n**604**: **CacheEntryIsIncompatible** \nAn entry could not be added to a schema cache as an entry with a \nmatching name, but with conflicting definitions.\n\n**700**: **XmlInvalidStructure** \nThe XML document structure is invalid for this purpose.\n\n**701**: **XmlMissingNaming** \nAn XML element is missing the name attribute.\n\n**702**: **XmlMissingSyntax** \nAn XML element is missing the syntax attribute.\n\n**703**: **XmlMissingProperty** \nAn XML element is missing the property attribute.\n\n**704**: **XmlUnknownElementAttribute** \nAn XML element has an unknown attribute.\n\n**800**: **RecycleBinFailed** \nA recycle bin operation failed\n\n**900**: **ConfigCacheEntryIncompatible** \nThe data underlying a config cache entry changed, rendering the existing entry incompatible (e.g. DN changed)\n" format: int32 Core_WebSDK_ConfigWebRequest_find: type: object properties: ObjectDN: type: string description: The object dn. Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' ObjectPattern: type: string description: The pattern. Class: type: string description: The class. IncludeDerivedClasses: type: boolean description: '**true** if derived classes will be included; otherwise, **false**.' AttributeName: type: string description: The attribute name. AttributeNames: type: array items: type: string description: The attribute name list. Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebRequest_removednvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_mutateobject: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_write: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_idinfo: type: object properties: ClassName: type: string description: A schema class name. GUID: type: string description: An object GUID. ObjectDN: type: string description: An oject DN. HierarchicalGUID: 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. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_dntoguid: type: object properties: ClassName: type: string description: A schema class name. GUID: type: string description: An object GUID. HierarchicalGUID: 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. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_clearattribute: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_findobjectsofclass: 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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_class: type: object properties: ClassDefinition: type: object properties: Id: type: integer description: The storage ID. format: int32 Property: $ref: '#/components/schemas/Core_SchemaClass_Properties' Name: type: string description: 'The name for this _SchemaClass_ object.' SuperClassNames: type: array items: type: string description: The super class names. ContainmentNames: type: array items: type: string description: The containment names. ContainmentSubNames: type: array items: type: string description: The containment sub names. OptionalNames: type: array items: type: string description: The optional names. OptionalNamesEx: type: array items: type: string description: The optional attribute names. SuperClassesExNames: type: array items: type: string description: The super class names. description: A schema class definition. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readdn: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebRequest_containableclasses: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_writepolicy: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_read: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_guidtodn: type: object properties: ClassName: type: string description: A schema class name. ObjectDN: type: string description: An oject DN. Revision: type: integer description: The revision. format: int64 HierarchicalGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself.. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_addpolicyvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_findpolicy: type: object properties: PolicyDN: type: string description: The DN of the object the policy values are inherited from Locked: type: - boolean - 'null' description: '**true** if locked; otherwise, **false**.' Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. 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_ConfigWebResponse_readdn: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_enumeratepolicies: type: object properties: Policies: type: array items: type: object properties: GUID: type: string description: "The _GUID_ associated \nwith this _ConfigPolicy_ object." TypeName: type: string description: A schema class name. AttributeName: type: string description: A schema attribute name. ValueList: type: array items: type: string description: A list of values Property: $ref: '#/components/schemas/Core_ConfigPolicy_Properties' description: The CyberArk storage system for effective attribute values. description: The policies. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_renameobject: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_readeffectivepolicy: type: object properties: Values: type: array items: type: string description: A list of values. Overridden: type: - boolean - 'null' description: '**true** if overriden; otherwise, **false**.' Locked: type: - boolean - 'null' description: '**true** if locked; otherwise, **false**.' PolicyDN: type: string description: The DN of the object the policy values are inherited from Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_enumerateobjectsderivedfrom: 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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_addvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_removepolicyvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_findcontainers: 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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_read: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebRequest_getrevision: type: object properties: ObjectID: type: integer description: The ID of the object whose revision to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose revision to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebRequest_enumerateall: required: - Pattern - ObjectDN type: object properties: Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" ObjectDN: type: string description: The object dn. Core_SchemaAttribute_Syntaxes: title: Data typing for values of a schema attribute enum: - 0 - 2 - 2 - 5 - 5 - 7 - 7 - 11 - 11 - 24 - 24 - 24 - 25 - 26 - 27 - 28 type: integer description: "\n\n**0**: **None** \nA default internal enumeration.\n\n**2**: **Boolean** \nThe attribute value is a boolean.\n\n**2**: **Bool** \nThe attribute value is a boolean.\n\n**5**: **CaseIgnoreString** \nThe attribute value is a case insensitive string.\n\n**5**: **String** \nThe attribute value is a case insensitive string.\n\n**7**: **DistinguishedName** \nThe attribute value is the complete name of an object within \nthe storage system.\n\n**7**: **DN** \nThe attribute value is the complete name of an object within \nthe storage system.\n\n**11**: **Integer** \nThe attribute value is an integer.\n\n**11**: **Int** \nThe attribute value is an integer.\n\n**24**: **Date** \nThe attribute value is representing a date/time value.\n\n**24**: **Time** \nThe attribute value is representing a date/time value.\n\n**24**: **DateTime** \nThe attribute value is representing a date/time value.\n\n**25**: **Identity** \nThe attributes value is an identity entry value\n\n**26**: **Secret** \nThe attribute value is a vault ID (vault data is encrypted in secret store)\n\n**27**: **CertificateSecret** \nThe attribute value is a certificate vault ID (vault data is cleartext in secret store)\n\n**28**: **File** \nThe attribute value is a vault ID (vault data is cleartext in secret store)\n" format: int32 Core_WebSDK_ConfigWebResponse_clearpolicyattribute: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_removepolicyvalue: required: - Class - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebRequest_getobjecttrustees: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_delete: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_clearpolicyattribute: required: - Class - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to clear. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to clear. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebRequest_countobjects: type: object properties: ObjectID: type: integer description: The ID of the object whose children to count. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose children to count. Only honored if ObjectID is not provided. Type: type: string description: The object type. Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebRequest_findcontainers: type: object properties: ObjectID: type: integer description: The ID of the object whose children to search. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose children to search. Only honored if ObjectID is not provided. Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' Core_WebSDK_ConfigWebRequest_removevalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_attributes: type: object properties: AttributeDefinitions: type: array items: type: object properties: Syntax: $ref: '#/components/schemas/Core_SchemaAttribute_Syntaxes' Property: $ref: '#/components/schemas/Core_SchemaAttribute_Properties' Name: type: string description: The attribute name Id: type: integer description: Gets the attribute ID format: int64 description: The CyberArk storage system for schema attributes. description: A list of schema attribute definitions. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readeffectivepolicy: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_ConfigPolicy_Properties: title: Behavioural properties for effective attribute values enum: - 0 - 1 type: integer description: "\n\n**0**: **None** \nAn unsed internal enumeration.\n\n**1**: **Locked** \nThe effective attribute value is locked by the owning object.\n\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\n" format: int32 Core_WebSDK_ConfigWebRequest_addpolicyvalue: required: - Class - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' Core_WebSDK_ConfigWebRequest_gethighestrevision: type: object properties: ObjectID: type: integer description: The ID of the object whose revision to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose revision to read. Only honored if ObjectID is not provided. Classes: type: array items: type: string description: The classes. Core_WebSDK_ConfigWebResponse_enumerateall: 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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_defaultdn: type: object properties: DefaultDN: type: string description: The default DN. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_gethighestrevision: type: object properties: Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_IdentityType: title: Enumeration defining Identity type objects enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 type: integer description: "\n\n**0**: **Undefined** \nUndefined\n\n**1**: **User** \nUser object\n\n**2**: **Group** \nGroup object\n\n**4**: **Container** \nContainer of users and groups\n\n**8**: **DistributionList** \nDistribution List\n\n**16**: **Machine** \nMachine\n\n**32**: **Provider** \nThe Identity Provider\n\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\n" format: int32 Core_WebSDK_ConfigWebRequest_dntoguid: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebRequest_readpolicy: required: - AttributeName - Class type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Class: type: string description: The class. Core_IdentityEntry_EntryState: title: Enumeration indicating the state of an IdentityEntry enum: - 0 - 1 - 2 - 4 - 8 type: integer description: "\n\n**0**: **Normal** \nNo special state associated with the entry\n\n**1**: **Disabled** \nThe identity has been disabled\n\n**2**: **LockedOut** \nThe identity has been locked out\n\n**4**: **Deleted** \nThe identity has been deleted\n\n**8**: **Unverifiable** \nThe identity could not be verified with a provider\n\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\n" format: int32 Core_WebSDK_ConfigWebRequest_findpolicy: required: - Class - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object to find policy for. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object to find policy for. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebRequest_delete: type: object properties: ObjectID: type: integer description: The ID of the object to delete. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object to delete. Only honored if ObjectID is not provided. Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' Core_WebSDK_ConfigWebRequest_adddnvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebRequest_mutateobject: required: - ObjectDN - Class type: object properties: ObjectDN: type: string description: The object dn. Class: type: string description: The class. Core_WebSDK_ConfigWebRequest_enumerate: required: - Recursive - Pattern - ObjectDN type: object properties: Recursive: type: boolean description: 'Boolean indicating if children of returned objects should be returned as well * **true**: Return children and children of children. * **false**: Default. Only return objects in the specified container.' Pattern: type: string description: "An expression for filtering matches. \n\n\n\nWildcards are asterisk (*) and question mark (?), to escape a wildcard use two backslashes (\\\\)" ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebRequest_writepolicy: required: - Class - AttributeName - Values type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to write. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' Core_WebSDK_ConfigWebRequest_enumeratepolicies: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebRequest_isvalid: type: object properties: ObjectDN: type: string description: The object dn. ObjectID: type: integer description: Gets or sets the object id. format: int64 ObjectGUID: type: string description: The object GUID. Core_WebSDK_ConfigWebRequest_writedn: required: - AttributeName - Values type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to write. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Core_WebSDK_ConfigWebResponse_enumerate: 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: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_attribute: type: object properties: AttributeDefinition: type: object properties: Syntax: $ref: '#/components/schemas/Core_SchemaAttribute_Syntaxes' Property: $ref: '#/components/schemas/Core_SchemaAttribute_Properties' Name: type: string description: The attribute name Id: type: integer description: Gets the attribute ID format: int64 description: A schema attribute definition. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readall: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebResponse_removevalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_addvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebSchemaRequest_attribute: type: object properties: Attribute: type: string description: The attribute. Core_WebSDK_ConfigWebRequest_idinfo: required: - ObjectID type: object properties: ObjectID: type: integer description: Gets or sets the object id. format: int64 Core_WebSDK_ConfigWebSchemaRequest_class: type: object properties: Class: type: string description: The class. Core_WebSDK_ConfigWebResponse_adddnvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_removednvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. securitySchemes: AccessToken: type: http scheme: bearer