openapi: 3.2.0 info: title: Trust Protection Foundation WebSDK Credential 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: Credential APIs description: 'The Credentials interface stores information about credentials for use in requesting certificates and other activities.' paths: /vedsdk/credentials/adaptable/create: post: tags: - Credential APIs summary: Create Adaptable credential description: 'Create an Adaptable Credential, which is a reference to a vault secret. _Required scope: security:manage_' operationId: Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_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/credentials/adaptable/update: post: tags: - Credential APIs summary: Update Adaptable credential description: 'Update field values in an Adaptable Credential. _Required scope: security:manage_' operationId: Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_update' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_update' '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/credentials/cyberark/create: post: tags: - Credential APIs summary: Create CyberArk credential description: 'Create an entry in the policy folder to match credential information in a CyberArk Safe. _Required scope: security:manage_' operationId: Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse' /vedsdk/credentials/cyberark/update: post: tags: - Credential APIs summary: Update CyberArk credential description: 'Update credentials to match credential information in a CyberArk Safe. _Required scope: security:manage_' operationId: Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse' /vedsdk/Credentials/create: post: tags: - Credential APIs summary: Create a new credential description: 'When adding Amazon credentials for _ADFS_ or _EC2AssignedRole_ sources, the credentials will be validated before storing them. _Required scope: security:manage_' operationId: Venafi_Core_WebSDK_CredentialsRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_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/Credentials/delete: post: tags: - Credential APIs summary: Delete a credential description: '_Required scope: security:delete_' operationId: Venafi_Core_WebSDK_CredentialsRest_Delete requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_delete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_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/Credentials/enumerate: post: tags: - Credential APIs summary: Enumerate all credentials description: '_Required scope: security_' operationId: Venafi_Core_WebSDK_CredentialsRest_Enumerate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_enumerate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_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/Credentials/rename: post: tags: - Credential APIs summary: Rename a credential description: '_Required scope: security:manage_' operationId: Venafi_Core_WebSDK_CredentialsRest_Rename requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_rename' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_rename' '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/Credentials/retrieve: post: tags: - Credential APIs summary: Retrieve a credential description: '_Required scope: security:manage_' operationId: Venafi_Core_WebSDK_CredentialsRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_retrieve' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_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/Credentials/update: post: tags: - Credential APIs summary: Update a credential description: '_Required scope: security:manage_' operationId: Venafi_Core_WebSDK_CredentialsRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_update' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_update' '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_CredentialsWebResponse_retrieve: type: object properties: Shared: type: boolean description: '**true** if shown when browsing for credentials; otherwise, **false**.' Contact: 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 contact. Expiration: type: string description: Expiration date of the credential (in MS Dateime JSON format - milliseconds since 1/1/1970) EncryptionKey: type: string description: The encryption key. Description: type: string description: The description. FriendlyName: type: string description: The friendly name. Classname: type: string description: The classname. Values: 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: '' description: The description. Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_rename: required: - CredentialPath - NewCredentialPath type: object properties: CredentialPath: type: string description: The DN of the credential to rename NewCredentialPath: type: string description: The new DN of the credential. Must be the same parent DN as *CredentialPath*, move is not allowed WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_create: required: - CredentialType - CredentialPath - ConnectorPath type: object properties: CustomFields: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The custom fields to be passed to the Adaptable Credential script ConnectorName: type: string description: The name of the Adaptable Credential Connector to use CredentialType: type: string description: The type of credential that the script will return CredentialPath: type: string description: The path of the Adaptable Credential to update or create WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_update: type: object properties: Error: type: string description: /// Gets or sets the error. WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_create: type: object properties: Error: type: string description: /// Gets or sets the error. WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest: type: object properties: ConnectorName: type: string description: The name of the CyberArk Credential Connector to use CyberArkUsername: type: string description: Gets or sets the CyberArk username. CyberArkPassword: type: string description: Gets or sets the CyberArk password. Username: type: string description: 'Gets or sets the username. If this property is present in the request (even if empty or null), a UsernamePassword credential is created. If this property is not present in the request, a Password-only credential is created.' AppID: type: string description: Gets or sets the application ID. SafeName: type: string description: Gets or sets the safe name. FolderName: type: string description: Gets or sets the folder name. AccountName: type: string description: Gets or sets the account name. DualAccount: type: string description: 'Gets or sets the dual account mode. Accepts boolean (true/false) or string values ("1"/"0", "true"/"false").' VirtualUserName: type: string description: Gets or sets the virtual user name Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: 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: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: 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: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. NewCredentialPath: type: string description: The new distinguished name (DN) path for the credential after renaming. Pattern: type: string description: A pattern string used to match credential names. Recursive: type: boolean description: '**true** if the search should include subcontainers; otherwise, **false**.' description: CyberArk credentials web request. Core_WebSDK_CredentialsWebRequest_delete: required: - CredentialPath type: object properties: CredentialPath: type: string description: DN of the credential to delete Core_WebSDK_CredentialsWebResponse_delete: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebResponse_rename: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_CredentialResult: title: Error codes for Credential methods enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 112 - 113 - 114 - 115 - 116 - 117 - 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 - 600 - 601 - 602 - 603 - 604 - 700 - 701 - 702 - 703 - 704 - 800 - 801 - 802 - 803 - 804 - 1000 - 1001 - 1002 - 1003 - 1004 - 1005 - 1006 - 1007 - 1008 - 1009 - 1010 - 1011 type: integer description: "\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**: **InvalidNullArgument** \nA null argument was passed to a method that does not allow null.\n\n**11**: **FailedToObtainConfig** \nCould not get a config handle.\n\n**12**: **FailedToObtainSecretStore** \nCould not get a secret store handle.\n\n**13**: **InvalidContainerPath** \nThe provided container path does not start at the credentials root.\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**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 it's 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**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**: **AdaptableCredentialNotSupportedType** \nThe represented credential type by the Adaptable Credential is not supported.\n\n**801**: **AdaptableCredentialScriptHashMismatch** \nThe Adaptable Credential PowerShell script is modified.\n\n**802**: **AdaptableCredentialScriptError** \nThere is an error returned by the Adaptable Credential PowerShell script.\n\n**803**: **AdaptableCredentialInvalidConnectorData** \nThe Adaptable Connector data is invalid.\n\n**804**: **AdaptableCredentialUnexpectedScriptResult** \nAn unexpected Result is returned by the Adaptable Credential PowerShell script.\n\n**1000**: **SecretStoreFailed** \nThe credential data could not be stored in secret store\n\n**1001**: **AddAttributeFailed** \nAttributes could not be added to vault object\n\n**1002**: **UnexpectedException** \nEncountered an exception that was not handled\n\n**1003**: **PartialDeleteFailure** \nEncountered an a problem deleting a object in a recursive delete; partial delete may already have happened\n\n**1004**: **CredentialTypeMismatch** \nTried to update a credential with a credential of a different type\n\n**1005**: **NoDriver** \nCould not find a driver for the credential object\n\n**1006**: **VaultTypeMismatch** \nThe secret stored in the vault doesn't match the type the credential expects\n\n**1007**: **DriverDenied** \nThe credential driver denied renaming the credential\n\n**1008**: **VaultDataUnrecognized** \nThe vault data was not any support format\n\n**1009**: **KeyStoreFailed** \nThe credential failed to be stored in the KeyStore\n\n**1010**: **CredentialIsInRecycleBin** \nThe credential failed because it was already in the recycle bin and should be purged prior to reimporting it\n\n**1011**: **CredentialMissingPrivateData** \nThe credential is missing private data required for its type (e.g., private key for a certificate or password for Username credential)\n" format: int32 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_CredentialsWebRequest_retrieve: required: - CredentialPath type: object properties: CredentialPath: type: string description: The DN of the credential to retrieve Core_WebSDK_CredentialsWebRequest_create: required: - Description - Contact - FriendlyName - Classname - Values - CredentialPath type: object properties: Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: 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: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: 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: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse: type: object properties: Username: type: string description: Gets or sets the username. Password: type: string description: Gets or sets the password. AppID: type: string description: Gets or sets the application ID. SafeName: type: string description: Gets or sets the safe name. FolderName: type: string description: Gets or sets the folder name. AccountName: type: string description: Gets or sets the account name. Error: type: string description: Gets or sets the error. Shared: type: boolean description: '**true** if shown when browsing for credentials; otherwise, **false**.' Contact: 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 contact. Expiration: type: string description: Expiration date of the credential (in MS Dateime JSON format - milliseconds since 1/1/1970) EncryptionKey: type: string description: The encryption key. Description: type: string description: The description. FriendlyName: type: string description: The friendly name. Classname: type: string description: The classname. CredentialInfos: type: array items: type: object properties: ClassName: type: string description: Gets/sets the config class name FullName: type: string description: Gets/sets the full path and name of the credential description: Class describing a credential item description: The credential infos. Values: 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: '' description: The description. Result: $ref: '#/components/schemas/Core_CredentialResult' description: CyberArk credentials web response. Core_WebSDK_CredentialsWebRequest_enumerate: required: - CredentialPath type: object properties: CredentialPath: type: string description: Container whose credential objects to enumerate Pattern: type: string description: Pattern to filter by Recursive: type: boolean description: If *true*, subcontainers are searched as well 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_CredentialsWebResponse_update: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebResponse_create: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebResponse_enumerate: type: object properties: CredentialInfos: type: array items: type: object properties: ClassName: type: string description: Gets/sets the config class name FullName: type: string description: Gets/sets the full path and name of the credential description: Class describing a credential item description: A list of credential objects matching the criteria Result: $ref: '#/components/schemas/Core_CredentialResult' 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 WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_update: required: - CustomFields - CredentialType - CredentialPath - ConnectorPath type: object properties: CustomFields: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The custom fields to be passed to the Adaptable Credential script ConnectorName: type: string description: The name of the Adaptable Credential Connector to use CredentialType: type: string description: The type of credential that the script will return CredentialPath: type: string description: The path of the Adaptable Credential to update or create Core_WebSDK_CredentialsWebRequest_update: required: - Description - Contact - FriendlyName - Classname - Values - CredentialPath type: object properties: Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: 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: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: 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: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. securitySchemes: AccessToken: type: http scheme: bearer