Package | Description |
---|---|
com.fortanix.sdkms.v1 | |
com.fortanix.sdkms.v1.api |
Modifier and Type | Method and Description |
---|---|
<T> T |
ApiClient.deserialize(javax.ws.rs.core.Response response,
javax.ws.rs.core.GenericType<T> returnType)
Deserialize response body to Java object according to the Content-Type.
|
File |
ApiClient.downloadFileFromResponse(javax.ws.rs.core.Response response)
Download file from the given response.
|
<T> T |
ApiClient.invokeAPI(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
javax.ws.rs.core.GenericType<T> returnType)
Invoke API by sending HTTP request with the given options.
|
javax.ws.rs.client.Entity<?> |
ApiClient.serialize(Object obj,
Map<String,Object> formParams,
String contentType)
Serialize the given Java object into string entity according the given
Content-Type (only JSON is supported for now).
|
Modifier and Type | Method and Description |
---|---|
void |
SecurityObjectsApi.activateSecurityObject(String keyId)
Transitions immediately a security object to Active state
Trigger the transition of a security object to Active state.
|
KeyObject |
SecurityObjectsApi.agreeKey(AgreeKeyRequest body)
Agree on a key from two other keys
This does a cryptographic key agreement operation between a public and private key.
|
void |
ApprovalRequestsApi.approve(String requestId)
Approve a request.
|
AuthResponse |
AuthenticationApi.authorize()
Create a session for a user or an app
Authenticate a user or an app to SDKMS to begin a session.
|
void |
TwoFactorAuthenticationApi.authorizeRecoveryCode()
Use a backup recovery code to complete authentication
Complete two factor authentication with a backup recovery code.
|
void |
TwoFactorAuthenticationApi.authorizeU2F()
Use a U2F key to complete authentication
Complete two factor authentication with a U2F authentication token to authenticate to SDKMS.
|
BatchDecryptResponse |
EncryptionAndDecryptionApi.batchDecrypt(BatchDecryptRequest body)
Batch decrypt with one or more keys
The data to be decrypted and the key ids to be used are provided in the request body.
|
BatchEncryptResponse |
EncryptionAndDecryptionApi.batchEncrypt(BatchEncryptRequest body)
Batch encrypt with one or more keys
The data to be encrypted and the key ids to be used are provided in the request body.
|
BatchSignResponse |
SignAndVerifyApi.batchSign(BatchSignRequest body)
Batch sign with one or more private keys
The data to be signed and the key ids to be used are provided in the request body.
|
BatchVerifyResponse |
SignAndVerifyApi.batchVerify(BatchVerifyRequest body)
Batch verify with one or more private keys
The signature to be verified and the key ids to be used are provided in the request body.
|
void |
UsersApi.changePassword(PasswordChangeRequest body)
Change user password
|
void |
AuthenticationApi.checkHealth()
Check whether the server is handling requests
Returns a 200-class status code if the server is handling requests, or a 500-class status code if the server is having problems.
|
DigestResponse |
DigestApi.computeDigest(DigestRequest body)
Compute a message digest of data
This returns the digest of data provided in request body using the algorithm specified in request body.
|
MacGenerateResponse |
DigestApi.computeMac(String keyId,
MacGenerateRequest body)
Compute MAC using a key
Compute a cryptographic Message Authentication Code on a message using a symmetric key.
|
MacGenerateResponse |
DigestApi.computeMacEx(MacGenerateRequestEx body)
Compute MAC using a key
Compute a cryptographic Message Authentication Code on a message using a symmetric key.
|
ConfirmEmailResponse |
UsersApi.confirmEmail(String userId,
ConfirmEmailRequest body)
Confirms user's email address
|
Account |
AccountsApi.createAccount(AccountRequest body)
Create a new account
Create a new account with the specified properties.
|
App |
AppsApi.createApp(AppRequest body)
Create a new application
Create a new application with the specified properties.
|
ApprovalRequest |
ApprovalRequestsApi.createApprovalRequest(ApprovalRequestRequest body)
Create approval request
|
Group |
GroupsApi.createGroup(GroupRequest body)
Create new group
Create a new group with the specified properties.
|
Plugin |
PluginsApi.createPlugin(PluginRequest body)
Create a new plugin
Create a new plugin with the specified properties.
|
User |
UsersApi.createUser(SignupRequest body)
Create a new user
Signs up a new user.
|
DecryptResponse |
EncryptionAndDecryptionApi.decrypt(String keyId,
DecryptRequest body)
Decrypt data
Decrypt data using a symmetric or asymmetric key.
|
DecryptResponse |
EncryptionAndDecryptionApi.decryptEx(DecryptRequestEx body)
Decrypt data
Decrypt data using a symmetric or asymmetric key.
|
DecryptFinalResponse |
EncryptionAndDecryptionApi.decryptFinal(String keyId,
DecryptFinalRequest body)
Conclude multi-part decryption
Conclude a multi-part decryption operation.
|
DecryptFinalResponse |
EncryptionAndDecryptionApi.decryptFinalEx(DecryptFinalRequestEx body)
Conclude multi-part decryption
Conclude a multi-part decryption operation.
|
DecryptInitResponse |
EncryptionAndDecryptionApi.decryptInit(String keyId,
DecryptInitRequest body)
Begin multi-part decryption
This API is used when decrypting more data than the client wishes to submit in a single request.
|
DecryptInitResponse |
EncryptionAndDecryptionApi.decryptInitEx(DecryptInitRequestEx body)
Begin multi-part decryption
This API is used when decrypting more data than the client wishes to submit in a single request.
|
DecryptUpdateResponse |
EncryptionAndDecryptionApi.decryptUpdate(String keyId,
DecryptUpdateRequest body)
Continue multi-part decryption
Continue a multi-part decryption operation.
|
DecryptUpdateResponse |
EncryptionAndDecryptionApi.decryptUpdateEx(DecryptUpdateRequestEx body)
Continue multi-part decryption
Continue a multi-part decryption operation.
|
void |
AccountsApi.deleteAccount(String accountId)
Delete account
Remove an account from SDKMS.
|
void |
AppsApi.deleteApp(String appId)
Delete application
Remove an application from SDKMS.
|
void |
ApprovalRequestsApi.deleteApprovalRequest(String requestId)
Delete an approval request.
|
void |
GroupsApi.deleteGroup(String groupId)
Delete group
Remove a group from SDKMS.
|
void |
PluginsApi.deletePlugin(String pluginId)
Delete plugin
Remove a plugin from SDKMS.
|
void |
SecurityObjectsApi.deletePrivateKey(String keyId)
Remove / Destroy private half of the asymmetric key
Removes the private portion of an asymmetric key from SDKMS.
|
void |
SecurityObjectsApi.deleteSecurityObject(String keyId)
Delete a security object
Delete a specified security object.
|
void |
UsersApi.deleteUser(String userId)
Removed user's association with an account
|
void |
UsersApi.deleteUserAccount()
Completely delete a user profile from system
Completely deletes the currently logged in user from the system.
|
void |
ApprovalRequestsApi.deny(String requestId)
Deny a request.
|
KeyObject |
SecurityObjectsApi.deriveKey(String keyId,
DeriveKeyRequest body)
Derive a key from another key
This derives a key from an existing key and returns the properties of the new key.
|
KeyObject |
SecurityObjectsApi.deriveKeyEx(DeriveKeyRequestEx body)
Derive a key from another key
This derives a key from an existing key and returns the properties of the new key.
|
EncryptResponse |
EncryptionAndDecryptionApi.encrypt(String keyId,
EncryptRequest body)
Encrypt data
Encrypt data using a symmetric or asymmetric key.
|
EncryptResponse |
EncryptionAndDecryptionApi.encryptEx(EncryptRequestEx body)
Encrypt data
Encrypt data using a symmetric or asymmetric key.
|
EncryptFinalResponse |
EncryptionAndDecryptionApi.encryptFinal(String keyId,
EncryptFinalRequest body)
Conclude multi-part encryption
Conclude a multi-part encryption operation.
|
EncryptFinalResponse |
EncryptionAndDecryptionApi.encryptFinalEx(EncryptFinalRequestEx body)
Conclude multi-part encryption
Conclude a multi-part encryption operation.
|
EncryptInitResponse |
EncryptionAndDecryptionApi.encryptInit(String keyId,
EncryptInitRequest body)
Begin multi-part encryption
This API is used when encrypting more data than the client wishes to submit in a single request.
|
EncryptInitResponse |
EncryptionAndDecryptionApi.encryptInitEx(EncryptInitRequestEx body)
Begin multi-part encryption
This API is used when encrypting more data than the client wishes to submit in a single request.
|
EncryptUpdateResponse |
EncryptionAndDecryptionApi.encryptUpdate(String keyId,
EncryptUpdateRequest body)
Continue multi-part encryption
Continue a multi-part encryption operation.
|
EncryptUpdateResponse |
EncryptionAndDecryptionApi.encryptUpdateEx(EncryptUpdateRequestEx body)
Continue multi-part encryption
Continue a multi-part encryption operation.
|
void |
UsersApi.forgotPassword(ForgotPasswordRequest body)
Initiate password reset sequence for a user
|
RecoveryCodes |
TwoFactorAuthenticationApi.generateRecoveryCodes()
Generate backup recovery codes for the current user
Generate backup recovery codes that may be used to complete complete two factor authentication.
|
KeyObject |
SecurityObjectsApi.generateSecurityObject(SobjectRequest body)
Generate a new security object
Generate a new security object (such as an RSA key pair or an AES key) of the requested size or elliptic curve.
|
MfaChallenge |
TwoFactorAuthenticationApi.generateU2FChallenge()
Generate a new challenge for registering a U2F devices
Generate a new challenge that may be used to register U2F devices.
|
Account |
AccountsApi.getAccount(String accountId)
Get a specific account
Look up an account by account ID.
|
List<Account> |
AccountsApi.getAccounts()
Get all accounts
Get detailed information on all accounts the current user has access to.
|
App |
AppsApi.getApp(String appId)
Get a specific application
Look up an application by application ID.
|
ApprovalRequest |
ApprovalRequestsApi.getApprovalRequest(String requestId)
Get an approval request.
|
List<ApprovalRequest> |
ApprovalRequestsApi.getApprovalRequests(String requester,
String reviewer,
String subject,
String status)
Get all approval requests
|
List<App> |
AppsApi.getApps(String groupId)
Get all applications
Get details of all applications the current user has access to.
|
List<App> |
AppsApi.getApps(String groupId,
String sort,
String start,
Integer limit,
Integer offset)
Get all applications
Get details of all applications the current user has access to.
|
AuditLogResponse |
LogsApi.getAuditLogs(Integer size,
Integer from,
String actionType,
String actorType,
String actorId,
String objectId,
String severity,
Integer rangeFrom,
Integer rangeTo)
Get audit logs
Get audit log entries matching the requested filters.
|
AppCredentialResponse |
AppsApi.getCredential(String appId)
Get a specific application's credential
Retrieve the authentication credential (API key or certificate) for a particular application.
|
Group |
GroupsApi.getGroup(String groupId)
Get a specific group
Look up a specific group by group ID.
|
List<Group> |
GroupsApi.getGroups()
Get all groups
Get detailed information about all groups the authenticated User or authenticated Application belongs to.
|
Plugin |
PluginsApi.getPlugin(String pluginId)
Get a specific plugin
Look up plugin by plugin ID.
|
List<Plugin> |
PluginsApi.getPlugins(String groupId)
Get all plugins
Get details of all plugins the current user has access to.
|
List<Plugin> |
PluginsApi.getPlugins(String groupId,
String sort,
String start,
Integer limit,
Integer offset)
Get all plugins
Get details of all plugins the current user has access to.
|
ApprovableResult |
ApprovalRequestsApi.getResult(String requestId)
Get the result for an approved or failed request.
|
KeyObject |
SecurityObjectsApi.getSecurityObject(String keyId)
Get a specific security object
Get the details of a particular security object.
|
DigestResponse |
SecurityObjectsApi.getSecurityObjectDigest(ObjectDigestRequest body)
Retrieve the digest (hash) of the value of an exportable security object
|
List<KeyObject> |
SecurityObjectsApi.getSecurityObjects(String name,
String groupId,
String creator)
Get all security objects
Return detailed information about the security objects stored in Fortanix SDKMS.
|
List<KeyObject> |
SecurityObjectsApi.getSecurityObjects(String name,
String groupId,
String creator,
String sort,
String start,
Integer limit,
Integer offset)
Get all security objects
Return detailed information about the security objects stored in Fortanix SDKMS.
|
KeyObject |
SecurityObjectsApi.getSecurityObjectValue(String keyId)
Retrieve the value of an exportable security object
Get the details and value of a particular exportable security object.
|
KeyObject |
SecurityObjectsApi.getSecurityObjectValueEx(SobjectDescriptor body)
Retrieve the value of an exportable security object
Get the details and value of a particular exportable security object.
|
VersionResponse |
AuthenticationApi.getServerVersion()
Get SDKMS version information
Returns information about the SDKMS server version and the client API version that it supports.
|
User |
UsersApi.getUser(String userId)
Get a specific user
|
UserAccountMap |
UsersApi.getUserAccount()
Get account information for the user
Obtain the current user's account information.
|
List<User> |
UsersApi.getUsers(String groupId)
Get all users
|
List<User> |
UsersApi.getUsers(String groupId,
String sort,
String start,
Integer limit,
Integer offset)
Get all users
|
KeyObject |
SecurityObjectsApi.importSecurityObject(SobjectRequest body)
Import a security object
Import a security object into SDKMS.
|
User |
UsersApi.inviteUser(UserRequest body)
Invite a user
Invite an existing user or new user to join an existing account.
|
PluginInvokeResponse |
PluginsApi.invokePlugin(String pluginId,
PluginInvokeRequest body)
Invoke a plugin
Invokes a plugin execution with the provided request body as input to the plugin.
|
void |
TwoFactorAuthenticationApi.lock2F()
Lock two factor configuration
Lock two factor configuration after completing two factor reconfiguration.
|
KeyObject |
SecurityObjectsApi.persistSecurityObject(PersistTransientKeyRequest body)
Persist a transient key.
|
void |
UsersApi.processInvitations(ProcessInviteRequest body)
Process a user's pending account invitations
Process a user's pending invitations.
|
App |
AppsApi.regenerateApiKey(String appId,
AppResetSecretRequest body)
Regenerate API key
Create a new API key for an application.
|
void |
UsersApi.resendConfirmEmail(String userId)
Resend email with link to confirm user's email address
|
void |
UsersApi.resendInvitation(String userId)
Resend invite to the user to join a specific account
|
void |
UsersApi.resetPassword(String userId,
PasswordResetRequest body)
Reset a user's password
Resetting a user's password.
|
void |
SecurityObjectsApi.revokeSecurityObject(String keyId,
RevocationReason body)
Transitions immediately a security object to Deactivated or Compromised state
Trigger the transition of a security object to Deactivated or Compromised state depending on the RevocationReason Code.
|
KeyObject |
SecurityObjectsApi.rotateSecurityObject(SobjectRequest body)
Rotate a key.
|
SelectAccountResponse |
AuthenticationApi.selectAccount(SelectAccountRequest body)
Select a user's account to work on
Select one of user's account to proceed.
|
SignResponse |
SignAndVerifyApi.sign(String keyId,
SignRequest body)
Sign with a private key
Sign data with a private key.
|
SignResponse |
SignAndVerifyApi.signEx(SignRequestEx body)
Sign with a private key
Sign data with a private key.
|
PluginInvokeResponse |
PluginsApi.sysV1PluginsInvokePluginIdGet(String pluginId)
Invoke a plugin using GET.
|
void |
AuthenticationApi.terminate()
Terminate a session
Terminate an authenticated session.
|
void |
AuthenticationApi.unlock2F()
Unlock two factor configuration
Re-authenticate to unlock two factor configuration.
|
KeyObject |
WrappingAndUnwrappingApi.unwrapKey(String keyId,
UnwrapKeyRequest body)
Unwrap a security object with a key
Unwrap (decrypt) a wrapped key and import it into SDKMS.
|
KeyObject |
WrappingAndUnwrappingApi.unwrapKeyEx(UnwrapKeyRequestEx body)
Unwrap a security object with a key
Unwrap (decrypt) a wrapped key and import it into SDKMS.
|
Account |
AccountsApi.updateAccount(String accountId,
AccountRequest body)
Update account
Update the properties of an account.
|
App |
AppsApi.updateApp(String appId,
AppRequest body)
Update an application
Change an application's properties, such as name, description, or group membership.
|
Group |
GroupsApi.updateGroup(String groupId,
GroupRequest body)
Update group
Change a group's properties.
|
App |
PluginsApi.updatePlugin(String pluginId,
PluginRequest body)
Update a plugin
Change a plugin's properties, such as name, description, code, or group membership.
|
KeyObject |
SecurityObjectsApi.updateSecurityObject(String keyId,
SobjectRequest body)
Update a security object
Update the properties of a security object.
|
User |
UsersApi.updateUser(String userId,
UserRequest body)
Update user
Change a user's properties.
|
ValidateTokenResponse |
UsersApi.validatePasswordResetToken(String userId,
ValidateTokenRequest body)
Validates password reset token for the user
|
VerifyResponse |
SignAndVerifyApi.verify(String keyId,
VerifyRequest body)
Verify a signature with a key
Verify a signature with a public key.
|
VerifyResponse |
SignAndVerifyApi.verifyEx(VerifyRequestEx body)
Verify a signature with a key
Verify a signature with a public key.
|
MacVerifyResponse |
DigestApi.verifyMac(String keyId,
MacVerifyRequest body)
Verify MAC using a key
The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL.
|
MacVerifyResponse |
DigestApi.verifyMacEx(MacVerifyRequestEx body)
Verify MAC using a key
The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL.
|
WrapKeyResponse |
WrappingAndUnwrappingApi.wrapKey(String keyId,
WrapKeyRequest body)
Wrap a security object with a key
Wrap (encrypt) an existing security object with a key.
|
WrapKeyResponse |
WrappingAndUnwrappingApi.wrapKeyEx(WrapKeyRequestEx body)
Wrap a security object with a key
Wrap (encrypt) an existing security object with a key.
|
Copyright © 2017-2019 Fortanix Inc. All Rights Reserved