Skip to content

akeylesslabs/akeyless-javascript

This branch is 1 commit ahead of, 34 commits behind master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e742840 · Jul 11, 2023
Jul 11, 2023
Nov 18, 2020
Jul 10, 2023
Jul 10, 2023
Jul 10, 2023
Nov 18, 2020
Mar 29, 2021
Nov 18, 2020
Nov 18, 2020
Aug 3, 2022
Jul 10, 2023
Nov 18, 2020
Nov 18, 2020
Jul 11, 2023
Jul 10, 2023

Repository files navigation

akeyless

akeyless - JavaScript client for akeyless The purpose of this application is to provide access to Akeyless API. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Package version: 3.3.15
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://akeyless.io

To install this package, use:

npm install akeyless

Getting started

const akeyless = require('akeyless');

const client = new akeyless.ApiClient();

// default: public API Gateway
client.basePath = 'https://api.akeyless.io';

// use port 8081 exposed by the deployment:
// client.basePath = 'https://gateway.company.com:8081';

// use port 8080 exposed by the deployment with /v2 prefix:
// client.basePath = 'https://gateway.company.com:8080/v2';

const api = new akeyless.V2Api(client);

api.auth(akeyless.Auth.constructFromObject({
    'admin-email': "foo@example.com",
    'admin-password': "strong-password",
})).then(data => data.token)
    .then(token => {
        return api.getSecretValue(akeyless.GetSecretValue.constructFromObject({
            'name': 'my-secret',
        }))
    })
    .then(console.log)
    .catch(console.log)

Documentation for API Endpoints

All URIs are relative to https://api.akeyless.io

Class Method HTTP request Description
akeyless.V2Api assocRoleAuthMethod POST /assoc-role-am
akeyless.V2Api assocTargetItem POST /assoc-target-item
akeyless.V2Api auth POST /auth
akeyless.V2Api configure POST /configure
akeyless.V2Api connect POST /connect
akeyless.V2Api createAWSTarget POST /create-aws-target
akeyless.V2Api createArtifactoryTarget POST /create-artifactory-target
akeyless.V2Api createAuthMethod POST /create-auth-method
akeyless.V2Api createAuthMethodAWSIAM POST /create-auth-method-aws-iam
akeyless.V2Api createAuthMethodAzureAD POST /create-auth-method-azure-ad
akeyless.V2Api createAuthMethodCert POST /create-auth-method-cert
akeyless.V2Api createAuthMethodEmail POST /create-auth-method-email
akeyless.V2Api createAuthMethodGCP POST /create-auth-method-gcp
akeyless.V2Api createAuthMethodHuawei POST /create-auth-method-huawei
akeyless.V2Api createAuthMethodK8S POST /create-auth-method-k8s
akeyless.V2Api createAuthMethodLDAP POST /create-auth-method-ldap
akeyless.V2Api createAuthMethodOAuth2 POST /create-auth-method-oauth2
akeyless.V2Api createAuthMethodOIDC POST /create-auth-method-oidc
akeyless.V2Api createAuthMethodSAML POST /create-auth-method-saml
akeyless.V2Api createAuthMethodUniversalIdentity POST /create-auth-method-universal-identity
akeyless.V2Api createAzureTarget POST /create-azure-target
akeyless.V2Api createCertificate POST /create-certificate
akeyless.V2Api createClassicKey POST /create-classic-key
akeyless.V2Api createDBTarget POST /create-db-target
akeyless.V2Api createDFCKey POST /create-dfc-key
akeyless.V2Api createDockerhubTarget POST /create-dockerhub-target
akeyless.V2Api createDynamicSecret POST /create-dynamic-secret
akeyless.V2Api createEKSTarget POST /create-eks-target
akeyless.V2Api createESM POST /create-esm
akeyless.V2Api createEventForwarder POST /create-event-forwarder
akeyless.V2Api createGKETarget POST /create-gke-target
akeyless.V2Api createGcpTarget POST /create-gcp-target
akeyless.V2Api createGithubTarget POST /create-github-target
akeyless.V2Api createGlobalSignTarget POST /create-globalsign-target
akeyless.V2Api createKey POST /create-key
akeyless.V2Api createLinkedTarget POST /create-linked-target
akeyless.V2Api createNativeK8STarget POST /create-k8s-target
akeyless.V2Api createPKICertIssuer POST /create-pki-cert-issuer
akeyless.V2Api createPingTarget POST /create-ping-target
akeyless.V2Api createRabbitMQTarget POST /create-rabbitmq-target
akeyless.V2Api createRole POST /create-role
akeyless.V2Api createRotatedSecret POST /create-rotated-secret
akeyless.V2Api createSSHCertIssuer POST /create-ssh-cert-issuer
akeyless.V2Api createSSHTarget POST /create-ssh-target
akeyless.V2Api createSalesforceTarget POST /create-salesforce-target
akeyless.V2Api createSecret POST /create-secret
akeyless.V2Api createTokenizer POST /create-tokenizer
akeyless.V2Api createWebTarget POST /create-web-target
akeyless.V2Api createWindowsTarget POST /create-windows-target
akeyless.V2Api createZeroSSLTarget POST /create-zerossl-target
akeyless.V2Api createldapTarget POST /create-ldap-target
akeyless.V2Api decrypt POST /decrypt
akeyless.V2Api decryptGPG POST /decrypt-gpg
akeyless.V2Api decryptPKCS1 POST /decrypt-pkcs1
akeyless.V2Api decryptWithClassicKey POST /decrypt-with-classic-key
akeyless.V2Api deleteAuthMethod POST /delete-auth-method
akeyless.V2Api deleteAuthMethods POST /delete-auth-methods
akeyless.V2Api deleteEventForwarder POST /delete-event-forwarder
akeyless.V2Api deleteGatewayAllowedAccessId POST /gateway-delete-allowed-management-access
akeyless.V2Api deleteGwCluster POST /delete-gateway-cluster
akeyless.V2Api deleteItem POST /delete-item
akeyless.V2Api deleteItems POST /delete-items
akeyless.V2Api deleteRole POST /delete-role
akeyless.V2Api deleteRoleAssociation POST /delete-assoc
akeyless.V2Api deleteRoleRule POST /delete-role-rule
akeyless.V2Api deleteRoles POST /delete-roles
akeyless.V2Api deleteTarget POST /delete-target
akeyless.V2Api deleteTargetAssociation POST /delete-assoc-target-item
akeyless.V2Api deleteTargets POST /delete-targets
akeyless.V2Api deriveKey POST /derive-key
akeyless.V2Api describeAssoc POST /describe-role-am-assoc
akeyless.V2Api describeItem POST /describe-item
akeyless.V2Api describePermissions POST /describe-permissions
akeyless.V2Api describeSubClaims POST /describe-sub-claims
akeyless.V2Api detokenize POST /detokenize
akeyless.V2Api encrypt POST /encrypt
akeyless.V2Api encryptGPG POST /encrypt-gpg
akeyless.V2Api encryptWithClassicKey POST /encrypt-with-classic-key
akeyless.V2Api esmCreate POST /esm-create
akeyless.V2Api esmDelete POST /esm-delete
akeyless.V2Api esmGet POST /esm-get
akeyless.V2Api esmList POST /esm-list
akeyless.V2Api esmUpdate POST /esm-update
akeyless.V2Api eventAction POST /event-action
akeyless.V2Api exportClassicKey POST /export-classic-key
akeyless.V2Api gatewayCreateAllowedAccess POST /gateway-create-allowed-access
akeyless.V2Api gatewayCreateK8SAuthConfig POST /gateway-create-k8s-auth-config
akeyless.V2Api gatewayCreateMigration POST /gateway-create-migration
akeyless.V2Api gatewayCreateProducerArtifactory POST /gateway-create-producer-artifactory
akeyless.V2Api gatewayCreateProducerAws POST /gateway-create-producer-aws
akeyless.V2Api gatewayCreateProducerAzure POST /gateway-create-producer-azure
akeyless.V2Api gatewayCreateProducerCassandra POST /gateway-create-producer-cassandra
akeyless.V2Api gatewayCreateProducerCertificateAutomation POST /gateway-create-producer-certificate-automation
akeyless.V2Api gatewayCreateProducerCustom POST /gateway-create-producer-custom
akeyless.V2Api gatewayCreateProducerDockerhub POST /gateway-create-producer-dockerhub
akeyless.V2Api gatewayCreateProducerEks POST /gateway-create-producer-eks
akeyless.V2Api gatewayCreateProducerGcp POST /gateway-create-producer-gcp
akeyless.V2Api gatewayCreateProducerGithub POST /gateway-create-producer-github
akeyless.V2Api gatewayCreateProducerGke POST /gateway-create-producer-gke
akeyless.V2Api gatewayCreateProducerHanaDb POST /gateway-create-producer-hanadb
akeyless.V2Api gatewayCreateProducerLdap POST /gateway-create-producer-ldap
akeyless.V2Api gatewayCreateProducerMSSQL POST /gateway-create-producer-mssql
akeyless.V2Api gatewayCreateProducerMongo POST /gateway-create-producer-mongo
akeyless.V2Api gatewayCreateProducerMySQL POST /gateway-create-producer-mysql
akeyless.V2Api gatewayCreateProducerNativeK8S POST /gateway-create-producer-k8s
akeyless.V2Api gatewayCreateProducerOracleDb POST /gateway-create-producer-oracle
akeyless.V2Api gatewayCreateProducerPing POST /gateway-create-producer-ping
akeyless.V2Api gatewayCreateProducerPostgreSQL POST /gateway-create-producer-postgresql
akeyless.V2Api gatewayCreateProducerRabbitMQ POST /gateway-create-producer-rabbitmq
akeyless.V2Api gatewayCreateProducerRdp POST /gateway-create-producer-rdp
akeyless.V2Api gatewayCreateProducerRedis POST /gateway-create-producer-Redis
akeyless.V2Api gatewayCreateProducerRedshift POST /gateway-create-producer-redshift
akeyless.V2Api gatewayCreateProducerSnowflake POST /gateway-create-producer-snowflake
akeyless.V2Api gatewayDeleteAllowedAccess POST /gateway-delete-allowed-access
akeyless.V2Api gatewayDeleteK8SAuthConfig POST /gateway-delete-k8s-auth-config
akeyless.V2Api gatewayDeleteMigration POST /gateway-delete-migration
akeyless.V2Api gatewayDeleteProducer POST /gateway-delete-producer
akeyless.V2Api gatewayDownloadCustomerFragments POST /gateway-download-customer-fragments
akeyless.V2Api gatewayGetAllowedAccess POST /gateway-get-allowed-access
akeyless.V2Api gatewayGetConfig POST /gateway-get-config
akeyless.V2Api gatewayGetK8SAuthConfig POST /gateway-get-k8s-auth-config
akeyless.V2Api gatewayGetLdapAuthConfig POST /gateway-get-ldap-auth-config
akeyless.V2Api gatewayGetMigration POST /gateway-get-migration
akeyless.V2Api gatewayGetProducer POST /gateway-get-producer
akeyless.V2Api gatewayGetTmpUsers POST /gateway-get-producer-tmp-creds
akeyless.V2Api gatewayListMigration POST /gateway-list-migration
akeyless.V2Api gatewayListProducers POST /gateway-list-producers
akeyless.V2Api gatewayListRotatedSecrets POST /gateway-list-rotated-secrets
akeyless.V2Api gatewayMigratePersonalItems POST /gateway-migrate-personal-items
akeyless.V2Api gatewayRevokeTmpUsers POST /gateway-revoke-producer-tmp-creds
akeyless.V2Api gatewayStartProducer POST /gateway-start-producer
akeyless.V2Api gatewayStatusMigration POST /gateway-migration-status
akeyless.V2Api gatewayStopProducer POST /gateway-stop-producer
akeyless.V2Api gatewaySyncMigration POST /gateway-sync-migration
akeyless.V2Api gatewayUpdateAllowedAccess POST /gateway-update-allowed-access
akeyless.V2Api gatewayUpdateItem POST /gateway-update-item
akeyless.V2Api gatewayUpdateK8SAuthConfig POST /gateway-update-k8s-auth-config
akeyless.V2Api gatewayUpdateLdapAuthConfig POST /gateway-update-ldap-auth-config
akeyless.V2Api gatewayUpdateMigration POST /gateway-update-migration
akeyless.V2Api gatewayUpdateProducerArtifactory POST /gateway-update-producer-artifactory
akeyless.V2Api gatewayUpdateProducerAws POST /gateway-update-producer-aws
akeyless.V2Api gatewayUpdateProducerAzure POST /gateway-update-producer-azure
akeyless.V2Api gatewayUpdateProducerCassandra POST /gateway-update-producer-cassandra
akeyless.V2Api gatewayUpdateProducerCertificateAutomation POST /gateway-update-producer-certificate-automation
akeyless.V2Api gatewayUpdateProducerCustom POST /gateway-update-producer-custom
akeyless.V2Api gatewayUpdateProducerDockerhub POST /gateway-update-producer-dockerhub
akeyless.V2Api gatewayUpdateProducerEks POST /gateway-update-producer-eks
akeyless.V2Api gatewayUpdateProducerGcp POST /gateway-update-producer-gcp
akeyless.V2Api gatewayUpdateProducerGithub POST /gateway-update-producer-github
akeyless.V2Api gatewayUpdateProducerGke POST /gateway-update-producer-gke
akeyless.V2Api gatewayUpdateProducerHanaDb POST /gateway-update-producer-hana
akeyless.V2Api gatewayUpdateProducerLdap POST /gateway-update-producer-ldap
akeyless.V2Api gatewayUpdateProducerMSSQL POST /gateway-update-producer-mssql
akeyless.V2Api gatewayUpdateProducerMongo POST /gateway-update-producer-mongo
akeyless.V2Api gatewayUpdateProducerMySQL POST /gateway-update-producer-mysql
akeyless.V2Api gatewayUpdateProducerNativeK8S POST /gateway-update-producer-k8s
akeyless.V2Api gatewayUpdateProducerOracleDb POST /gateway-update-producer-oracle
akeyless.V2Api gatewayUpdateProducerPing POST /gateway-update-producer-ping
akeyless.V2Api gatewayUpdateProducerPostgreSQL POST /gateway-update-producer-postgresql
akeyless.V2Api gatewayUpdateProducerRabbitMQ POST /gateway-update-producer-rabbitmq
akeyless.V2Api gatewayUpdateProducerRdp POST /gateway-update-producer-rdp
akeyless.V2Api gatewayUpdateProducerRedis POST /gateway-update-producer-redis
akeyless.V2Api gatewayUpdateProducerRedshift POST /gateway-update-producer-redshift
akeyless.V2Api gatewayUpdateProducerSnowflake POST /gateway-update-producer-snowflake
akeyless.V2Api gatewayUpdateTlsCert POST /gateway-update-tls-cert
akeyless.V2Api gatewayUpdateTmpUsers POST /gateway-update-producer-tmp-creds
akeyless.V2Api generateCsr POST /generate-csr
akeyless.V2Api getAccountLogo POST /get-account-logo
akeyless.V2Api getAccountSettings POST /get-account-settings
akeyless.V2Api getAuthMethod POST /get-auth-method
akeyless.V2Api getCertificateValue POST /get-certificate-value
akeyless.V2Api getDynamicSecretValue POST /get-dynamic-secret-value
akeyless.V2Api getEventForwarder POST /get-event-forwarder
akeyless.V2Api getKubeExecCreds POST /get-kube-exec-creds
akeyless.V2Api getPKICertificate POST /get-pki-certificate
akeyless.V2Api getRSAPublic POST /get-rsa-public
akeyless.V2Api getRole POST /get-role
akeyless.V2Api getRotatedSecretValue POST /get-rotated-secret-value
akeyless.V2Api getSSHCertificate POST /get-ssh-certificate
akeyless.V2Api getSecretValue POST /get-secret-value
akeyless.V2Api getTags POST /get-tags
akeyless.V2Api getTarget POST /get-target
akeyless.V2Api getTargetDetails POST /get-target-details
akeyless.V2Api hmac POST /hmac
akeyless.V2Api importPasswords POST /import-passwords
akeyless.V2Api kmipClientDeleteRule POST /kmip-client-delete-rule
akeyless.V2Api kmipClientSetRule POST /kmip-client-set-rule
akeyless.V2Api kmipCreateClient POST /kmip-create-client
akeyless.V2Api kmipDeleteClient POST /kmip-delete-client
akeyless.V2Api kmipDeleteServer DELETE /kmip-delete-environment
akeyless.V2Api kmipDescribeClient POST /kmip-get-client
akeyless.V2Api kmipDescribeServer POST /kmip-get-environment
akeyless.V2Api kmipListClients POST /kmip-list-clients
akeyless.V2Api kmipMoveServer POST /kmip-move-environment
akeyless.V2Api kmipRenewClientCertificate POST /kmip-renew-client
akeyless.V2Api kmipRenewServerCertificate POST /kmip-renew-environment
akeyless.V2Api kmipServerSetup POST /kmip-create-environment
akeyless.V2Api kmipSetServerState POST /kmip-set-environment-state
akeyless.V2Api listAuthMethods POST /list-auth-methods
akeyless.V2Api listGateways POST /list-gateways
akeyless.V2Api listItems POST /list-items
akeyless.V2Api listRoles POST /list-roles
akeyless.V2Api listSRABastions POST /list-sra-bastions
akeyless.V2Api listSharedItems POST /list-shared-items
akeyless.V2Api listTargets POST /list-targets
akeyless.V2Api moveObjects POST /move-objects
akeyless.V2Api rawCreds POST /raw-creds
akeyless.V2Api refreshKey POST /refresh-key
akeyless.V2Api requestAccess POST /request-access
akeyless.V2Api reverseRBAC POST /reverse-rbac
akeyless.V2Api revokeCreds POST /revoke-creds
akeyless.V2Api rollbackSecret POST /rollback-secret
akeyless.V2Api rotateKey POST /rotate-key
akeyless.V2Api rotateSecret POST /gateway-rotate-secret
akeyless.V2Api setItemState POST /set-item-state
akeyless.V2Api setRoleRule POST /set-role-rule
akeyless.V2Api shareItem POST /share-item
akeyless.V2Api signDataWithClassicKey POST /sign-data-with-classic-key
akeyless.V2Api signGPG POST /sign-gpg
akeyless.V2Api signJWTWithClassicKey POST /sign-jwt-with-classic-key
akeyless.V2Api signPKCS1 POST /sign-pkcs1
akeyless.V2Api signPKICertWithClassicKey POST /sign-pki-cert-with-classic-key
akeyless.V2Api staticCredsAuth POST /static-creds-auth
akeyless.V2Api tokenize POST /tokenize
akeyless.V2Api uidCreateChildToken POST /uid-create-child-token
akeyless.V2Api uidGenerateToken POST /uid-generate-token
akeyless.V2Api uidListChildren POST /uid-list-children
akeyless.V2Api uidRevokeToken POST /uid-revoke-token
akeyless.V2Api uidRotateToken POST /uid-rotate-token
akeyless.V2Api updateAWSTarget POST /update-aws-target
akeyless.V2Api updateAWSTargetDetails POST /update-aws-target-details
akeyless.V2Api updateAccountSettings POST /update-account-settings
akeyless.V2Api updateArtifactoryTarget POST /update-artifactory-target
akeyless.V2Api updateAssoc POST /update-assoc
akeyless.V2Api updateAuthMethod POST /update-auth-method
akeyless.V2Api updateAuthMethodAWSIAM POST /update-auth-method-aws-iam
akeyless.V2Api updateAuthMethodAzureAD POST /update-auth-method-azure-ad
akeyless.V2Api updateAuthMethodCert POST /update-auth-method-cert
akeyless.V2Api updateAuthMethodGCP POST /update-auth-method-gcp
akeyless.V2Api updateAuthMethodK8S POST /update-auth-method-k8s
akeyless.V2Api updateAuthMethodLDAP POST /update-auth-method-ldap
akeyless.V2Api updateAuthMethodOAuth2 POST /update-auth-method-oauth2
akeyless.V2Api updateAuthMethodOIDC POST /update-auth-method-oidc
akeyless.V2Api updateAuthMethodSAML POST /update-auth-method-saml
akeyless.V2Api updateAuthMethodUniversalIdentity POST /update-auth-method-universal-identity
akeyless.V2Api updateAzureTarget POST /update-azure-target
akeyless.V2Api updateCertificateValue POST /update-certificate-value
akeyless.V2Api updateDBTarget POST /update-db-target
akeyless.V2Api updateDBTargetDetails POST /update-db-target-details
akeyless.V2Api updateDockerhubTarget POST /update-dockerhub-target
akeyless.V2Api updateEKSTarget POST /update-eks-target
akeyless.V2Api updateEventForwarder POST /update-event-forwarder
akeyless.V2Api updateGKETarget POST /update-gke-target
akeyless.V2Api updateGcpTarget POST /update-gcp-target
akeyless.V2Api updateGithubTarget POST /update-github-target
akeyless.V2Api updateGlobalSignTarget POST /update-globalsign-target
akeyless.V2Api updateItem POST /update-item
akeyless.V2Api updateLdapTarget POST /update-ldap-target
akeyless.V2Api updateLdapTargetDetails POST /update-ldap-target-details
akeyless.V2Api updateLinkedTarget POST /update-linked-target
akeyless.V2Api updateNativeK8STarget POST /update-k8s-target
akeyless.V2Api updatePKICertIssuer POST /update-pki-cert-issuer
akeyless.V2Api updatePingTarget POST /update-ping-target
akeyless.V2Api updateRDPTargetDetails POST /update-rdp-target-details
akeyless.V2Api updateRabbitMQTarget POST /update-rabbitmq-target
akeyless.V2Api updateRabbitMQTargetDetails POST /update-rabbitmq-target-details
akeyless.V2Api updateRole POST /update-role
akeyless.V2Api updateRotatedSecret POST /update-rotated-secret
akeyless.V2Api updateRotationSettings POST /update-rotation-settingsrotate-key
akeyless.V2Api updateSSHCertIssuer POST /update-ssh-cert-issuer
akeyless.V2Api updateSSHTarget POST /update-ssh-target
akeyless.V2Api updateSSHTargetDetails POST /update-ssh-target-details
akeyless.V2Api updateSalesforceTarget POST /update-salesforce-target
akeyless.V2Api updateSecretVal POST /update-secret-val
akeyless.V2Api updateTarget POST /update-target
akeyless.V2Api updateTargetDetails POST /update-target-details
akeyless.V2Api updateWebTarget POST /update-web-target
akeyless.V2Api updateWebTargetDetails POST /update-web-target-details
akeyless.V2Api updateWindowsTarget POST /update-windows-target
akeyless.V2Api updateZeroSSLTarget POST /update-zerossl-target
akeyless.V2Api uploadRSA POST /upload-rsa
akeyless.V2Api validateToken POST /validate-token
akeyless.V2Api verifyDataWithClassicKey POST /verify-data-with-classic-key
akeyless.V2Api verifyGPG POST /verify-gpg
akeyless.V2Api verifyJWTWithClassicKey POST /verify-jwt-with-classic-key
akeyless.V2Api verifyPKCS1 POST /verify-pkcs1
akeyless.V2Api verifyPKICertWithClassicKey POST /verify-pki-cert-with-classic-key

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.