@Generated(value="io.swagger.codegen.languages.JavaClientCodegen", date="2018-11-21T02:24:22.050Z") public class SecurityObjectsApi extends Object
Constructor and Description |
---|
SecurityObjectsApi() |
SecurityObjectsApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
KeyObject |
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 |
deletePrivateKey(String keyId)
Remove / Destroy private half of the asymmetric key
Removes the private portion of an asymmetric key from SDKMS.
|
void |
deleteSecurityObject(String keyId)
Delete a security object
Delete a specified security object.
|
KeyObject |
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 |
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.
|
KeyObject |
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.
|
ApiClient |
getApiClient() |
KeyObject |
getSecurityObject(String keyId)
Get a specific security object
Get the details of a particular security object.
|
DigestResponse |
getSecurityObjectDigest(ObjectDigestRequest body)
Retrieve the digest (hash) of the value of an exportable security object
|
List<KeyObject> |
getSecurityObjects(String name,
String groupId,
String creator)
Get all security objects
Return detailed information about the security objects stored in Fortanix SDKMS.
|
List<KeyObject> |
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 |
getSecurityObjectValue(String keyId)
Retrieve the value of an exportable security object
Get the details and value of a particular exportable security object.
|
KeyObject |
getSecurityObjectValueEx(SobjectDescriptor body)
Retrieve the value of an exportable security object
Get the details and value of a particular exportable security object.
|
KeyObject |
importSecurityObject(SobjectRequest body)
Import a security object
Import a security object into SDKMS.
|
KeyObject |
persistSecurityObject(PersistTransientKeyRequest body)
Persist a transient key.
|
void |
setApiClient(ApiClient apiClient) |
KeyObject |
updateSecurityObject(String keyId,
SobjectRequest body)
Update a security object
Update the properties of a security object.
|
public SecurityObjectsApi()
public SecurityObjectsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public KeyObject agreeKey(AgreeKeyRequest body) throws ApiException
body
- Template of the agreed-upon security object (required)ApiException
- if fails to make API callpublic void deletePrivateKey(String keyId) throws ApiException
keyId
- kid of security object (required)ApiException
- if fails to make API callpublic void deleteSecurityObject(String keyId) throws ApiException
keyId
- kid of security object (required)ApiException
- if fails to make API callpublic KeyObject deriveKey(String keyId, DeriveKeyRequest body) throws ApiException
keyId
- kid of security object (required)body
- Name of security object (required)ApiException
- if fails to make API callpublic KeyObject deriveKeyEx(DeriveKeyRequestEx body) throws ApiException
body
- Name of security object (required)ApiException
- if fails to make API callpublic KeyObject generateSecurityObject(SobjectRequest body) throws ApiException
body
- Request to create, update, or import security object (required)ApiException
- if fails to make API callpublic KeyObject getSecurityObject(String keyId) throws ApiException
keyId
- kid of security object (required)ApiException
- if fails to make API callpublic DigestResponse getSecurityObjectDigest(ObjectDigestRequest body) throws ApiException
body
- Object digest request (required)ApiException
- if fails to make API callpublic KeyObject getSecurityObjectValue(String keyId) throws ApiException
keyId
- kid of security object (required)ApiException
- if fails to make API callpublic KeyObject getSecurityObjectValueEx(SobjectDescriptor body) throws ApiException
body
- Request to export a security object (required)ApiException
- if fails to make API callpublic List<KeyObject> getSecurityObjects(String name, String groupId, String creator, String sort, String start, Integer limit, Integer offset) throws ApiException
name
- Only retrieve the security object with this name. (optional)groupId
- Only retrieve security objects in the specified group. (optional)creator
- Only retrieve security objects created by the user or application with the specified id. (optional)sort
- This specifies the property (`kid` or `name`) and order (ascending or descending) with which to sort the security objects. By default, security objects are sorted by `kid` in ascending order. The syntax is \"<property>:[asc|desc]\" (e.g. \"kid:desc\") or just \"<property>\" (ascending order by default). (optional)start
- If provided, this must be a value of the property specified in `sort`. Returned security objects will begin just above or just below this value (for asc/desc order resp.). (optional)limit
- Maximum number of security objects to return. If not provided, the limit is 100. (optional)offset
- Number of security objects past `start` to skip. (optional)ApiException
- if fails to make API callpublic List<KeyObject> getSecurityObjects(String name, String groupId, String creator) throws ApiException
name
- Only retrieve the security object with this name. (optional)groupId
- Only retrieve security objects in the specified group. (optional)creator
- Only retrieve security objects created by the user or application with the specified id. (optional)ApiException
- if fails to make API callpublic KeyObject importSecurityObject(SobjectRequest body) throws ApiException
body
- Request to create, update, or import security object (required)ApiException
- if fails to make API callpublic KeyObject persistSecurityObject(PersistTransientKeyRequest body) throws ApiException
body
- Persist transient key request (required)ApiException
- if fails to make API callpublic KeyObject updateSecurityObject(String keyId, SobjectRequest body) throws ApiException
keyId
- kid of security object (required)body
- Request to create, update, or import security object (required)ApiException
- if fails to make API callCopyright © 2017-2018 Fortanix Inc. All Rights Reserved