com.ibm.cloud.ibm_key_protect_api.v2.model

Class GetImportToken

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.ibm_key_protect_api.v2.model.GetImportToken

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GetImportToken
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The base schema for retrieving an import token.

Constructor Summary

Constructors

Constructor and Description
GetImportToken()

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Gets the creationDate.
Double	getExpiration() Gets the expiration.
Date	getExpirationDate() Gets the expirationDate.
Double	getMaxAllowedRetrievals() Gets the maxAllowedRetrievals.
byte[]	getNonce() Gets the nonce.
byte[]	getPayload() Gets the payload.
Double	getRemainingRetrievals() Gets the remainingRetrievals.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetImportToken

public GetImportToken()

Method Detail

getExpiration

public Double getExpiration()

Gets the expiration. The time in seconds from the creation of an import token that determines how long its associated public key remains valid. The minimum value is `300` seconds (5 minutes), and the maximum value is `86400` (24 hours). The default value is `600` (10 minutes).

Returns:

the expiration

getMaxAllowedRetrievals

public Double getMaxAllowedRetrievals()

Gets the maxAllowedRetrievals. The number of times that an import token can be retrieved within its expiration time before it is no longer accessible.

Returns:

the maxAllowedRetrievals

getCreationDate

public Date getCreationDate()

Gets the creationDate. The date the import token was created. The date format follows RFC 3339.

Returns:

the creationDate

getExpirationDate

public Date getExpirationDate()

Gets the expirationDate. The date the import token expires. The date format follows RFC 3339.

Returns:

the expirationDate

getRemainingRetrievals

public Double getRemainingRetrievals()

Gets the remainingRetrievals. The number of retrievals that are available for the import token before it is no longer accessible.

Returns:

the remainingRetrievals

getPayload

public byte[] getPayload()

Gets the payload. The public encryption key that you can use to encrypt key material before you import it into the service. This value is a PEM-encoded public key in PKIX format. Because PEM encoding is a byte format, the value is base64 encoded.

Returns:

the payload

getNonce

public byte[] getNonce()

Gets the nonce. The nonce value that is used to verify a key import request. Encrypt and provide the encrypted nonce value when you use `POST /keys` to securely import a key to the service.

Returns:

the nonce