openapi: 3.2.0 info: title: Trust Protection Foundation WebSDK SecretStore 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: SecretStore APIs description: SecretStore APIs paths: /vedsdk/X509CertificateStore/add: post: tags: - SecretStore APIs summary: Add an X509 certificate description: 'This method validates the request and adds either a single certificate or a collection of certificates to the certificate store. If a single certificate is added, the method logs the event and returns the vault ID of the added certificate. _Required scope: certificate:manage_' operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Add requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_add' required: true responses: '200': description: The certificate was successfully added to the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_add' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: ' The user is not authorized to add the certificate to the vault.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: ' An error occurred on the server while adding the certificate to the vault.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/lookup: post: tags: - SecretStore APIs summary: Lookup X509 certificates description: 'This method validates the request and looks up certificates in the certificate store based on the provided criteria. If a certificate is provided, it looks up the vault ID of the certificate. If an owner distinguished name (DN) is provided, it looks up all certificates owned by that DN. If a name and value are provided, it looks up all certificates matching the name and value. _Required scope: restricted_' operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Lookup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_lookup' required: true responses: '200': description: The certificates were successfully looked up in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_lookup' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to look up the certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while looking up the certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/lookupexpiring: post: tags: - SecretStore APIs summary: Lookup expiring X509 certificates description: 'This method validates the request and looks up certificates in the certificate store that are expiring within the specified number of days. If an owner distinguished name (DN) is provided, it looks up all certificates owned by that DN that are expiring within the specified number of days. _Required scope: restricted_' operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_LookupExpiring requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_lookupexpiring' required: true responses: '200': description: The expiring certificates were successfully looked up in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_lookupexpiring' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to look up the expiring certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while looking up the expiring certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/remove: post: tags: - SecretStore APIs summary: Remove an X509 certificate description: 'This method validates the request and removes a certificate from the certificate store. If a vault ID is provided, it removes the certificate associated with that vault ID. If a certificate is provided, it looks up the vault ID of the certificate and removes it. The method logs the event if the certificate is successfully removed. _Required scope: restricted:delete_' operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Remove requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_remove' required: true responses: '200': description: The certificate was successfully removed from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_remove' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to remove the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while removing the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/retrieve: post: tags: - SecretStore APIs summary: Retrieve an X509 certificate description: 'This method validates the request and retrieves a certificate from the certificate store based on the provided vault ID. The method also retrieves any associated names and values with the certificate. The method logs the event if the certificate is successfully retrieved. _Required scope: certificate:manage_' operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_retrieve' required: true responses: '200': description: The certificate was successfully retrieved from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_retrieve' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to retrieve the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while retrieving the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/secretstore/add: post: tags: - SecretStore APIs summary: Add a secret description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Add requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_add' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_add' '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/secretstore/availablenamespaces: get: tags: - SecretStore APIs summary: List available namespace description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_AvailableNamespaces responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_availablenamespaces' '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/secretstore/associate: post: tags: - SecretStore APIs summary: Add an association description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Associate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_associate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_associate' '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/secretstore/dissociate: post: tags: - SecretStore APIs summary: Remove an association description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Dissociate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_dissociate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_dissociate' '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/secretstore/encryptionkeysinuse: get: tags: - SecretStore APIs summary: Get encryption keys in use description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_EncryptionKeysInUse responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_encryptionkeysinuse' '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/secretstore/lookup: get: tags: - SecretStore APIs summary: Search a secret description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Lookup responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookup' '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/secretstore/lookupbyvaulttype: post: tags: - SecretStore APIs summary: Search by vault type description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupByVaultType requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyvaulttype' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyvaulttype' '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/secretstore/lookupbyassociation: post: tags: - SecretStore APIs summary: Search by association description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAssociation requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyassociation' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyassociation' '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/secretstore/lookupassociationbyvaultid: post: tags: - SecretStore APIs summary: Lookup association by vault id description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAssociationByVaultID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupassociationbyvaultid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupassociationbyvaultid' '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/secretstore/lookupallassociationsbyvaultid: post: tags: - SecretStore APIs summary: Get all associations by vault id description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAllAssociationsByVaultID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupallassociationsbyvaultid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupallassociationsbyvaultid' '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/secretstore/mutate: post: tags: - SecretStore APIs summary: Change secret type description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Mutate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_mutate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_mutate' '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/secretstore/lookupbyowner: post: tags: - SecretStore APIs summary: Search by owner description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupByOwner requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyowner' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyowner' '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/secretstore/owneradd: post: tags: - SecretStore APIs summary: Add an owner description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_OwnerAdd requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_owneradd' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_owneradd' '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/secretstore/ownerdelete: post: tags: - SecretStore APIs summary: Delete an owner description: '_Required scope: restricted:delete_' operationId: Venafi_Core_WebSDK_SecretStoreRest_OwnerDelete requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_ownerdelete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_ownerdelete' '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/secretstore/ownerlookup: post: tags: - SecretStore APIs summary: Get owners of a secret description: '_Required scope: restricted_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Ownerlookup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_ownerlookup' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_ownerlookup' '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/secretstore/retrieve: post: tags: - SecretStore APIs summary: Retrieve a secret description: '_Required scope: restricted:manage_' operationId: Venafi_Core_WebSDK_SecretStoreRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_retrieve' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_retrieve' '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/secretstore/rotatekey/{vaultid}: parameters: - name: vaultid in: path description: The Vault Id of the entry to rotate the key required: true schema: type: string get: tags: - SecretStore APIs summary: Rotate a key description: '_Required scope: admin:rotate_' operationId: Venafi_Core_WebSDK_SecretStoreRest_RotateKey parameters: - name: newkeyname in: query description: The name of the new key required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_rotatekey__vaultid_' '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_X509CertificateStoreWebRequest_add: required: - OwnerDN type: object properties: ProtectionKey: type: string description: The key used to protect the certificate. OwnerDN: type: string description: The distinguished name of the owner of the certificate. Core_WebSDK_SecretStoreWebResponse_lookupbyowner: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_availablenamespaces: type: object properties: Namespaces: type: array items: type: string description: The namespaces. Core_WebSDK_SecretStoreWebResponse_associate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_X509CertificateStoreWebRequest_lookup: type: object properties: OwnerDN: type: string description: The distinguished name of the owner of the certificate. Name: type: string description: The name associated with the certificate. Value: type: string description: The value associated with the certificate. Core_WebSDK_SecretStoreWebResponse_lookupassociationbyvaultid: type: object properties: Value: type: string description: The value. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_ownerdelete: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_X509CertificateStoreWebResponse_lookupexpiring: type: object properties: VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Nullable_1_Core_VaultType_: title: Enumerations of data types stored in the vault, if the Data should be secret the Secret bit should be set enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 - 1024 - 2048 - 4096 - 8192 - 16384 - 1073758208 - 1073741824 - 1073741826 - 1073741828 - 1073741832 - 1073741840 - 1073741856 - 1073741952 - 1073742080 - 1073742336 - 1073742848 - 1073743872 - 1073745920 - -2147483648 - -2147483392 - -1073741568 - -2147479552 - -1073737728 - -2147483640 - -1073741816 type: - integer - 'null' description: "\n\n**0**: **None** \n\n\n**1**: **PrivateKey** \nIndicates the stored data is a Private Key\n\n**2**: **Certificate** \nIndicates the stored data is a Certificate\n\n**4**: **PKCS12** \nIndicates the stored data is a PKCS12 blob\n\n**8**: **SymmetricKey** \nIndicates the stored data is a Symmetric Key\n\n**16**: **State** \nIndicates the stored data is an Assembly State Blob\n\n**32**: **Password** \nIndicates the stored data is a Password\n\n**64**: **Csr** \nIndicates the stored data is a Certificate Signing Request\n\n**128**: **Blob** \nIndicates the stored data is a Generic Blob\n\n**256**: **PKCS8** \nIndicates the stored data is a DER formated PKCS8 (Private Key)\n\n**512**: **PKCS10** \nIndicates the stored data is a DER formatted PKCS10 (CSR)\n\n**1024**: **File** \nIndicates the stored data is a regular file\n\n**2048**: **RSAPublicKey** \nIndicates the stored data is an RSA public key\n\n**4096**: **PublicKey** \nIndicates the stored data is a public key\n\n**8192**: **AccessGrant** \nIndicates the stored data is an access grant\n\n**16384**: **SshCertificate** \nIndicates the stored data is raw OpenSsh certificate material\n\n**1073758208**: **ArchivedSshCertificate** \nIndicates the stored data is deleted raw OpenSsh certificate material\n\n**1073741824**: **Archived** \nOverlay to indicate archived entries\n\n**1073741826**: **ArchivedCertificate** \nIndicates the stored data is a Certificate\n\n**1073741828**: **ArchivedPKCS12** \nIndicates the stored data is a PKCS12 blob\n\n**1073741832**: **ArchivedSymmetricKey** \nIndicates the stored data is a Symmetric Key\n\n**1073741840**: **ArchivedState** \nIndicates the stored data is an Assembly State Blob\n\n**1073741856**: **ArchivedPassword** \nIndicates the stored data is a Password\n\n**1073741952**: **ArchivedBlob** \nIndicates the stored data is a Generic Blob\n\n**1073742080**: **ArchivedPKCS8** \nIndicates the stored data is a DER formated PKCS8 (Private Key)\n\n**1073742336**: **ArchivedPKCS10** \nIndicates the stored data is a DER formatted PKCS10 (CSR)\n\n**1073742848**: **ArchivedFile** \nIndicates the stored data is a regular file\n\n**1073743872**: **ArchivedRSAPublicKey** \nIndicates the archived data is an RSA public key\n\n**1073745920**: **ArchivedPublicKey** \nIndicates the stored data is a public key\n\n**-2147483648**: **Refigram** \nOverlay to indicate Refigram entries.\n\n**-2147483392**: **RefigramPKCS8** \nIndicates the stored data is a refigram for a private key stored on an HSM\n\n**-1073741568**: **ArchivedRefigramPKCS8** \nIndicates the stored data is a refigram for a private key stored on an HSM\n\n**-2147479552**: **RefigramPublicKey** \nIndicates the stored data is a refigram for a public key stored on an HSM\n\n**-1073737728**: **ArchivedRefigramPublicKey** \nIndicates the stored data is a refigram for a public key stored on an HSM\n\n**-2147483640**: **RefigramSymmetricKey** \nIndicates the stored data is a refigram for a symmetric key stored on an HSM\n\n**-1073741816**: **ArchivedRefigramSymmetricKey** \nIndicates the stored data is a refigram for a symmetric key stored on an HSM\n" format: int32 Core_WebSDK_X509CertificateStoreWebResponse_lookup: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebResponse_remove: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebRequest_remove: required: - OwnerDN type: object properties: VaultId: type: - integer - 'null' description: The unique identifier of the certificate in the vault. format: int64 OwnerDN: type: string description: The distinguished name of the owner of the certificate. Core_WebSDK_SecretStoreWebResponse_mutate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_lookupbyvaulttype: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_retrieve: type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_SecretStoreWebResponse_encryptionkeysinuse: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' EncryptionKeys: type: array items: type: string description: The encryption keys. Core_WebSDK_SecretStoreWebRequest_retrieve: required: - VaultID type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Core_WebSDK_X509CertificateStoreWebRequest_retrieve: required: - VaultId type: object properties: VaultId: type: - integer - 'null' description: The unique identifier of the certificate in the vault. format: int64 Core_WebSDK_SecretStoreWebRequest_ownerdelete: required: - Namespace - Owner type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Namespace: type: string description: The namespace. Owner: type: string description: The owner. Core_WebSDK_SecretStoreWebResponse_owneradd: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_X509CertificateStoreWebResponse: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. ProtectionKey: type: string description: The key used to protect the certificate. CertificateString: type: string description: The base64-encoded string representation of the certificate. CertificateCollectionStrings: type: array items: type: string description: A list of base64-encoded string representations of the certificates in the collection. OwnerDN: type: string description: The distinguished name of the owner of the certificate. LeafExisted: type: - boolean - 'null' description: '**true** if the leaf certificate existed; otherwise, **false**.' Result: $ref: '#/components/schemas/Core_SecretStoreResult' Name: type: string description: The name associated with the certificate. Value: type: string description: The value associated with the certificate. TypedNameValues: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: Class representing a store association item description: A list of typed name-value pairs for serialization. description: Represents a response from operations performed on the X.509 certificate store. Core_WebSDK_X509CertificateStoreWebResponse_add: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 LeafExisted: type: - boolean - 'null' description: '**true** if the leaf certificate existed; otherwise, **false**.' Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_SecretStoreWebRequest_lookupbyvaulttype: required: - VaultType type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Core_WebSDK_SecretStoreWebResponse_add: type: object properties: VaultID: type: - integer - 'null' description: The vault ID. format: int64 Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_associate: required: - VaultID - Name type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: - integer - 'null' description: The int value. format: int64 DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebRequest_lookupbyowner: required: - Namespace - Owner type: object properties: Namespace: type: string description: The namespace. Owner: type: string description: The owner. VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Core_WebSDK_SecretStoreWebRequest_add: required: - VaultType - Data - Keyname - Namespace - Owner type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Keyname: type: string description: The keyname. Namespace: type: string description: The namespace. Owner: type: string description: The owner. 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_SecretStoreWebRequest_owneradd: required: - VaultID - Namespace - Owner type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Namespace: type: string description: The namespace. Owner: type: string description: The owner. Core_WebSDK_SecretStoreWebResponse_lookupbyassociation: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_lookupallassociationsbyvaultid: type: object properties: TypedNameValues: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: Class representing a store association item description: The typed name values. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_mutate: required: - VaultID - VaultType type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' StringValue: type: string description: The string value. IntValue: type: - integer - 'null' description: The int value. format: int64 DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebResponse_lookup: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_rotatekey__vaultid_: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_SecretStoreWebRequest_lookupallassociationsbyvaultid: required: - VaultID type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Name: type: string description: The name. Core_WebSDK_X509CertificateStoreWebRequest_lookupexpiring: required: - OwnerDN - DaysToExpiration type: object properties: OwnerDN: type: string description: The distinguished name of the owner of the certificate. DaysToExpiration: type: - integer - 'null' description: The number of days until the certificate expires. format: int32 Core_WebSDK_X509CertificateStoreWebResponse_retrieve: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_SecretStoreWebRequest_ownerlookup: required: - VaultID - Namespace type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Namespace: type: string description: The namespace. Core_WebSDK_SecretStoreWebResponse_ownerlookup: type: object properties: Owners: type: array items: type: string description: The owners. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_dissociate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupassociationbyvaultid: required: - VaultID - Name type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Name: type: string description: The name. Core_WebSDK_SecretStoreWebRequest_dissociate: required: - VaultID type: object properties: VaultID: type: - integer - 'null' description: The type of the vault. format: int64 Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: - integer - 'null' description: The int value. format: int64 DateValue: type: string description: The date value. Core_SecretStoreResult: title: Enumeration of SecretStore result codes enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 type: integer description: "\n\n**0**: **Success** \nIndicates the method completed succesfully.\n\n**1**: **InvalidCallingAssembly** \nIndicates the calling assembly is not signed by Venafi.\n\n**2**: **CreateDatabaseError** \nIndicates there was an error creating the Database.\n\n**3**: **UseDatabaseError** \nIndicates there was an error attempting 'use' the Database.\n\n**4**: **CreateTableError** \nIndicates there was an error creating the Database table(s).\n\n**5**: **CreateIndexError** \nIndicates there was an error creating the Database table index(s).\n\n**6**: **ConnectionError** \nIndicates there was an error connecting to the Database.\n\n**7**: **TransactionError** \nIndicates there as an error beginning a database transaction.\n\n**8**: **InvalidVaultID** \nIndicates the specified vaultid is invalid.\n\n**9**: **InvalidParams** \nIndicates one or more invalid parameters were passed to the function\n\n**10**: **InsufficientRights** \nIndicates the **Rights** passed in were insufficent to complete the requested action\n\n**11**: **CryptoFailure** \nIndicates the Crypto method(s) failed and the data cannot be inserted nor retrieved\n\n**12**: **DeleteSecretFailed** \nIndicates the deletion of a secret failed\n\n**13**: **AddSecretFailed** \nIndicates the adding of a secret failed\n\n**14**: **RetrieveSecretFailed** \nIndicates the retrieval of a secret failed\n\n**15**: **RetrieveSecretTypeFailed** \nIndicates the retrieval of the secret type failed\n\n**16**: **GetNextVaultIDFailed** \nIndicates there was an error getting the next available VaultID\n\n**17**: **DissacoiateFailed** \nIndicates the dissociation of data failed\n\n**18**: **OwnerLookupFailed** \nIndicates the OwnerLookup failed\n\n**19**: **AssociateDataFailed** \nIndicates the association of data failed\n\n**20**: **LookupFailed** \nIndicates the Lookup failed\n\n**21**: **InvalidKey** \nIndicates that an invalid encryption key name was provided\n\n**22**: **QueryError** \nIndicates an error occurred querying the repository\n\n**23**: **SecurityGroupNotImplemented** \nIndicates that the associated security group support is not implemented\n\n**24**: **RemoteError** \nA remote request failed; see Error property for details\n\n**25**: **VaultIdAlreadyExists** \nAn existing store entry already exists\n\n**26**: **OutOfMemory** \nAn operation could not be performed, at this time, due to resource constraints.\n\n**27**: **AssociationAlreadyExists** \nIndicates the association of data failed due to the fact that an existing matching association already exists.\n\n**28**: **VaultIdExceedsIntegerCapacity** \nThe operation succeeded but generated a vault ID that exceeds the 32-bit signed integer value.\n\n**29**: **AssociationLookupFailed** \nThe operation to retrieve data about a vault entry failed\n\n**30**: **AddRevocationStateFailed** \nThe operation to set the revocation state on a certificate failed\n\n**31**: **CertificateMigrationStateNotFound** \nThe certificate migration state was not found in the database\n\n**32**: **TodoManagerError** \nAn error occurred related to a todo manager operation\n\n**33**: **RotationError** \nAn error related to key rotation occurred\n\n**34**: **Cancelled** \nAn operation was cancelled\n\n**35**: **DeleteOwnerFailed** \nIndicates the removal of an owner failed\n" format: int32 Core_WebSDK_SecretStoreWebRequest_lookupbyassociation: required: - Name type: object properties: Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: - integer - 'null' description: The int value. format: int64 DateValue: type: string description: The date value. securitySchemes: AccessToken: type: http scheme: bearer