fortanix_sdkms_rest_api
Advanced tools
This_is_a_set_of_REST_APIs_for_accessing_the_Fortanix_Self_Defending_Key_Management_System__This_includes_APIs_for_managing_accounts_and_for_performing_cryptographic_and_key_management_operations_
FortanixSdkmsRestApi - JavaScript client for fortanix_sdkms_rest_api This is a set of REST APIs for accessing the Fortanix Self-Defending Key Management System. This includes APIs for managing accounts, and for performing cryptographic and key management operations. This SDK is automatically generated by the Swagger Codegen project:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install fortanix_sdkms_rest_api --save
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm link
Finally, switch to the directory you want to use your fortanix_sdkms_rest_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('fortanix_sdkms_rest_api') in javascript files from the directory you ran the last
command above from.
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var FortanixSdkmsRestApi = require('fortanix_sdkms_rest_api');
var defaultClient = FortanixSdkmsRestApi.ApiClient.instance;
// Configure API key authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerToken.apiKeyPrefix['Authorization'] = "Token"
var api = new FortanixSdkmsRestApi.AccountsApi()
var body = new FortanixSdkmsRestApi.AccountRequest(); // {AccountRequest} Properties to assign to Account.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createAccount(body, callback);
All URIs are relative to https://apps.smartkey.io
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FortanixSdkmsRestApi.AccountsApi | createAccount | POST /sys/v1/accounts | Create a new account |
| FortanixSdkmsRestApi.AccountsApi | deleteAccount | DELETE /sys/v1/accounts/{account-id} | Delete account |
| FortanixSdkmsRestApi.AccountsApi | getAccount | GET /sys/v1/accounts/{account-id} | Get a specific account |
| FortanixSdkmsRestApi.AccountsApi | getAccounts | GET /sys/v1/accounts | Get all accounts |
| FortanixSdkmsRestApi.AccountsApi | updateAccount | PATCH /sys/v1/accounts/{account-id} | Update account |
| FortanixSdkmsRestApi.ApprovalRequestsApi | approve | POST /sys/v1/approval_requests/{request-id}/approve | Approve a request. |
| FortanixSdkmsRestApi.ApprovalRequestsApi | createApprovalRequest | POST /sys/v1/approval_requests | Create approval request |
| FortanixSdkmsRestApi.ApprovalRequestsApi | deleteApprovalRequest | DELETE /sys/v1/approval_requests/{request-id} | Delete an approval request. |
| FortanixSdkmsRestApi.ApprovalRequestsApi | deny | POST /sys/v1/approval_requests/{request-id}/deny | Deny a request. |
| FortanixSdkmsRestApi.ApprovalRequestsApi | getApprovalRequest | GET /sys/v1/approval_requests/{request-id} | Get an approval request. |
| FortanixSdkmsRestApi.ApprovalRequestsApi | getApprovalRequests | GET /sys/v1/approval_requests | Get all approval requests |
| FortanixSdkmsRestApi.ApprovalRequestsApi | getResult | POST /sys/v1/approval_requests/{request-id}/result | Get the result for an approved or failed request. |
| FortanixSdkmsRestApi.AppsApi | createApp | POST /sys/v1/apps | Create a new application |
| FortanixSdkmsRestApi.AppsApi | deleteApp | DELETE /sys/v1/apps/{app-id} | Delete application |
| FortanixSdkmsRestApi.AppsApi | getApp | GET /sys/v1/apps/{app-id} | Get a specific application |
| FortanixSdkmsRestApi.AppsApi | getApps | GET /sys/v1/apps | Get all applications |
| FortanixSdkmsRestApi.AppsApi | getCredential | GET /sys/v1/apps/{app-id}/credential | Get a specific application's credential |
| FortanixSdkmsRestApi.AppsApi | regenerateApiKey | POST /sys/v1/apps/{app-id}/reset_secret | Regenerate API key |
| FortanixSdkmsRestApi.AppsApi | updateApp | PATCH /sys/v1/apps/{app-id} | Update an application |
| FortanixSdkmsRestApi.AuthenticationApi | authorize | POST /sys/v1/session/auth | Create a session for a user or an app |
| FortanixSdkmsRestApi.AuthenticationApi | checkHealth | GET /sys/v1/health | Check whether the server is handling requests |
| FortanixSdkmsRestApi.AuthenticationApi | getServerVersion | GET /sys/v1/version | Get SDKMS version information |
| FortanixSdkmsRestApi.AuthenticationApi | selectAccount | POST /sys/v1/session/select_account | Select a user's account to work on |
| FortanixSdkmsRestApi.AuthenticationApi | terminate | POST /sys/v1/session/terminate | Terminate a session |
| FortanixSdkmsRestApi.AuthenticationApi | unlock2F | POST /sys/v1/session/config_2fa/auth | Unlock two factor configuration |
| FortanixSdkmsRestApi.DigestApi | computeDigest | POST /crypto/v1/digest | Compute a message digest of data |
| FortanixSdkmsRestApi.DigestApi | computeMac | POST /crypto/v1/keys/{key-id}/mac | Compute MAC using a key |
| FortanixSdkmsRestApi.DigestApi | computeMacEx | POST /crypto/v1/mac | Compute MAC using a key |
| FortanixSdkmsRestApi.DigestApi | verifyMac | POST /crypto/v1/keys/{key-id}/macverify | Verify MAC using a key |
| FortanixSdkmsRestApi.DigestApi | verifyMacEx | POST /crypto/v1/macverify | Verify MAC using a key |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | batchDecrypt | POST /crypto/v1/keys/batch/decrypt | Batch decrypt with one or more keys |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | batchEncrypt | POST /crypto/v1/keys/batch/encrypt | Batch encrypt with one or more keys |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decrypt | POST /crypto/v1/keys/{key-id}/decrypt | Decrypt data |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptEx | POST /crypto/v1/decrypt | Decrypt data |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptFinal | POST /crypto/v1/keys/{key-id}/decrypt/final | Conclude multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptFinalEx | POST /crypto/v1/decrypt/final | Conclude multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptInit | POST /crypto/v1/keys/{key-id}/decrypt/init | Begin multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptInitEx | POST /crypto/v1/decrypt/init | Begin multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptUpdate | POST /crypto/v1/keys/{key-id}/decrypt/update | Continue multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | decryptUpdateEx | POST /crypto/v1/decrypt/update | Continue multi-part decryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encrypt | POST /crypto/v1/keys/{key-id}/encrypt | Encrypt data |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptEx | POST /crypto/v1/encrypt | Encrypt data |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptFinal | POST /crypto/v1/keys/{key-id}/encrypt/final | Conclude multi-part encryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptFinalEx | POST /crypto/v1/encrypt/final | Conclude multi-part encryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptInit | POST /crypto/v1/keys/{key-id}/encrypt/init | Begin multi-part encryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptInitEx | POST /crypto/v1/encrypt/init | Begin multi-part encryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptUpdate | POST /crypto/v1/keys/{key-id}/encrypt/update | Continue multi-part encryption |
| FortanixSdkmsRestApi.EncryptionAndDecryptionApi | encryptUpdateEx | POST /crypto/v1/encrypt/update | Continue multi-part encryption |
| FortanixSdkmsRestApi.GroupsApi | createGroup | POST /sys/v1/groups | Create new group |
| FortanixSdkmsRestApi.GroupsApi | deleteGroup | DELETE /sys/v1/groups/{group-id} | Delete group |
| FortanixSdkmsRestApi.GroupsApi | getGroup | GET /sys/v1/groups/{group-id} | Get a specific group |
| FortanixSdkmsRestApi.GroupsApi | getGroups | GET /sys/v1/groups | Get all groups |
| FortanixSdkmsRestApi.GroupsApi | updateGroup | PATCH /sys/v1/groups/{group-id} | Update group |
| FortanixSdkmsRestApi.LogsApi | getAuditLogs | GET /sys/v1/logs | Get audit logs |
| FortanixSdkmsRestApi.PluginsApi | createPlugin | POST /sys/v1/plugins | Create a new plugin |
| FortanixSdkmsRestApi.PluginsApi | deletePlugin | DELETE /sys/v1/plugins/{plugin-id} | Delete plugin |
| FortanixSdkmsRestApi.PluginsApi | getPlugin | GET /sys/v1/plugins/{plugin-id} | Get a specific plugin |
| FortanixSdkmsRestApi.PluginsApi | getPlugins | GET /sys/v1/plugins | Get all plugins |
| FortanixSdkmsRestApi.PluginsApi | invokePlugin | POST /sys/v1/plugins/{plugin-id} | Invoke a plugin |
| FortanixSdkmsRestApi.PluginsApi | sysV1PluginsInvokePluginIdGet | GET /sys/v1/plugins/invoke/{plugin-id} | Invoke a plugin using GET. |
| FortanixSdkmsRestApi.PluginsApi | updatePlugin | PATCH /sys/v1/plugins/{plugin-id} | Update a plugin |
| FortanixSdkmsRestApi.SecurityObjectsApi | agreeKey | POST /crypto/v1/agree | Agree on a key from two other keys |
| FortanixSdkmsRestApi.SecurityObjectsApi | deletePrivateKey | DELETE /crypto/v1/keys/{key-id}/private | Remove / Destroy private half of the asymmetric key |
| FortanixSdkmsRestApi.SecurityObjectsApi | deleteSecurityObject | DELETE /crypto/v1/keys/{key-id} | Delete a security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | deriveKey | POST /crypto/v1/keys/{key-id}/derive | Derive a key from another key |
| FortanixSdkmsRestApi.SecurityObjectsApi | deriveKeyEx | POST /crypto/v1/derive | Derive a key from another key |
| FortanixSdkmsRestApi.SecurityObjectsApi | generateSecurityObject | POST /crypto/v1/keys | Generate a new security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | getSecurityObject | GET /crypto/v1/keys/{key-id} | Get a specific security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | getSecurityObjectDigest | POST /crypto/v1/keys/digest | Retrieve the digest (hash) of the value of an exportable security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | getSecurityObjectValue | GET /crypto/v1/keys/{key-id}/export | Retrieve the value of an exportable security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | getSecurityObjectValueEx | POST /crypto/v1/keys/export | Retrieve the value of an exportable security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | getSecurityObjects | GET /crypto/v1/keys | Get all security objects |
| FortanixSdkmsRestApi.SecurityObjectsApi | importSecurityObject | PUT /crypto/v1/keys | Import a security object |
| FortanixSdkmsRestApi.SecurityObjectsApi | persistSecurityObject | POST /crypto/v1/keys/persist | Persist a transient key. |
| FortanixSdkmsRestApi.SecurityObjectsApi | updateSecurityObject | PATCH /crypto/v1/keys/{key-id} | Update a security object |
| FortanixSdkmsRestApi.SignAndVerifyApi | batchSign | POST /crypto/v1/keys/batch/sign | Batch sign with one or more private keys |
| FortanixSdkmsRestApi.SignAndVerifyApi | batchVerify | POST /crypto/v1/keys/batch/verify | Batch verify with one or more private keys |
| FortanixSdkmsRestApi.SignAndVerifyApi | sign | POST /crypto/v1/keys/{key-id}/sign | Sign with a private key |
| FortanixSdkmsRestApi.SignAndVerifyApi | signEx | POST /crypto/v1/sign | Sign with a private key |
| FortanixSdkmsRestApi.SignAndVerifyApi | verify | POST /crypto/v1/keys/{key-id}/verify | Verify a signature with a key |
| FortanixSdkmsRestApi.SignAndVerifyApi | verifyEx | POST /crypto/v1/verify | Verify a signature with a key |
| FortanixSdkmsRestApi.TwoFactorAuthenticationApi | authorizeRecoveryCode | POST /sys/v1/session/auth/2fa/recovery_code | Use a backup recovery code to complete authentication |
| FortanixSdkmsRestApi.TwoFactorAuthenticationApi | authorizeU2F | POST /sys/v1/session/auth/2fa/u2f | Use a U2F key to complete authentication |
| FortanixSdkmsRestApi.TwoFactorAuthenticationApi | generateRecoveryCodes | POST /sys/v1/users/generate_recovery_code | Generate backup recovery codes for the current user |
| FortanixSdkmsRestApi.TwoFactorAuthenticationApi | generateU2FChallenge | POST /sys/v1/session/config_2fa/new_challenge | Generate a new challenge for registering a U2F devices |
| FortanixSdkmsRestApi.TwoFactorAuthenticationApi | lock2F | POST /sys/v1/session/config_2fa/terminate | Lock two factor configuration |
| FortanixSdkmsRestApi.UsersApi | changePassword | POST /sys/v1/users/change_password | Change user password |
| FortanixSdkmsRestApi.UsersApi | confirmEmail | POST /sys/v1/users/{user-id}/confirm_email | Confirms user's email address |
| FortanixSdkmsRestApi.UsersApi | createUser | POST /sys/v1/users | Create a new user |
| FortanixSdkmsRestApi.UsersApi | deleteUser | DELETE /sys/v1/users/{user-id}/account | Removed user's association with an account |
| FortanixSdkmsRestApi.UsersApi | deleteUserAccount | DELETE /sys/v1/users | Completely delete a user profile from system |
| FortanixSdkmsRestApi.UsersApi | forgotPassword | POST /sys/v1/users/forgot_password | Initiate password reset sequence for a user |
| FortanixSdkmsRestApi.UsersApi | getUser | GET /sys/v1/users/{user-id} | Get a specific user |
| FortanixSdkmsRestApi.UsersApi | getUserAccount | GET /sys/v1/users/accounts | Get account information for the user |
| FortanixSdkmsRestApi.UsersApi | getUsers | GET /sys/v1/users | Get all users |
| FortanixSdkmsRestApi.UsersApi | inviteUser | POST /sys/v1/users/invite | Invite a user |
| FortanixSdkmsRestApi.UsersApi | processInvitations | POST /sys/v1/users/process_invite | Process a user's pending account invitations |
| FortanixSdkmsRestApi.UsersApi | resendConfirmEmail | POST /sys/v1/users/{user-id}/resend_confirm_email | Resend email with link to confirm user's email address |
| FortanixSdkmsRestApi.UsersApi | resendInvitation | POST /sys/v1/users/{user-id}/resend_invite | Resend invite to the user to join a specific account |
| FortanixSdkmsRestApi.UsersApi | resetPassword | POST /sys/v1/users/{user-id}/reset_password | Reset a user's password |
| FortanixSdkmsRestApi.UsersApi | updateUser | PATCH /sys/v1/users/{user-id} | Update user |
| FortanixSdkmsRestApi.UsersApi | validatePasswordResetToken | POST /sys/v1/users/{user-id}/validate_token | Validates password reset token for the user |
| FortanixSdkmsRestApi.WrappingAndUnwrappingApi | unwrapKey | POST /crypto/v1/keys/{key-id}/unwrapkey | Unwrap a security object with a key |
| FortanixSdkmsRestApi.WrappingAndUnwrappingApi | unwrapKeyEx | POST /crypto/v1/unwrapkey | Unwrap a security object with a key |
| FortanixSdkmsRestApi.WrappingAndUnwrappingApi | wrapKey | POST /crypto/v1/keys/{key-id}/wrapkey | Wrap a security object with a key |
| FortanixSdkmsRestApi.WrappingAndUnwrappingApi | wrapKeyEx | POST /crypto/v1/wrapkey | Wrap a security object with a key |
FAQs
This_is_a_set_of_REST_APIs_for_accessing_the_Fortanix_Self_Defending_Key_Management_System__This_includes_APIs_for_managing_accounts_and_for_performing_cryptographic_and_key_management_operations_
The npm package fortanix_sdkms_rest_api receives a total of 12 weekly downloads. As such, fortanix_sdkms_rest_api popularity was classified as not popular.
We found that fortanix_sdkms_rest_api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.