BackupKeyDetails The representation of BackupKeyDetails
type BackupKeyDetails struct { BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"` }
func (m BackupKeyDetails) String() string
func (m *BackupKeyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
BackupKeyRequest wrapper for the BackupKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupKey.go.html to see an example of how to use BackupKeyRequest.
type BackupKeyRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // BackupKeyDetails BackupKeyDetails `contributesTo:"body"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request BackupKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupKeyRequest) String() string
BackupKeyResponse wrapper for the BackupKey operation
type BackupKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // backup operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response BackupKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupKeyResponse) String() string
BackupLocation Backup upload location
type BackupLocation interface { }
BackupLocationBucket Object storage bucket details to upload or download the backup
type BackupLocationBucket struct { Namespace *string `mandatory:"true" json:"namespace"` BucketName *string `mandatory:"true" json:"bucketName"` ObjectName *string `mandatory:"true" json:"objectName"` }
func (m BackupLocationBucket) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BackupLocationBucket) String() string
BackupLocationDestinationEnum Enum with underlying type: string
type BackupLocationDestinationEnum string
Set of constants representing the allowable values for BackupLocationDestinationEnum
const ( BackupLocationDestinationBucket BackupLocationDestinationEnum = "BUCKET" BackupLocationDestinationPreAuthenticatedRequestUri BackupLocationDestinationEnum = "PRE_AUTHENTICATED_REQUEST_URI" )
func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum
GetBackupLocationDestinationEnumValues Enumerates the set of values for BackupLocationDestinationEnum
BackupLocationUri PreAuthenticated object storage URI to upload or download the backup
type BackupLocationUri struct { Uri *string `mandatory:"true" json:"uri"` }
func (m BackupLocationUri) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BackupLocationUri) String() string
BackupVaultDetails The representation of BackupVaultDetails
type BackupVaultDetails struct { BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"` IsIncludeKeys *bool `mandatory:"false" json:"isIncludeKeys"` }
func (m BackupVaultDetails) String() string
func (m *BackupVaultDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
BackupVaultRequest wrapper for the BackupVault operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupVault.go.html to see an example of how to use BackupVaultRequest.
type BackupVaultRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // BackupVaultDetails BackupVaultDetails `contributesTo:"body"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request BackupVaultRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupVaultRequest) String() string
BackupVaultResponse wrapper for the BackupVault operation
type BackupVaultResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // backup operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response BackupVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupVaultResponse) String() string
CancelKeyDeletionRequest wrapper for the CancelKeyDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletionRequest.
type CancelKeyDeletionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CancelKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelKeyDeletionRequest) String() string
CancelKeyDeletionResponse wrapper for the CancelKeyDeletion operation
type CancelKeyDeletionResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CancelKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelKeyDeletionResponse) String() string
CancelKeyVersionDeletionRequest wrapper for the CancelKeyVersionDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletionRequest.
type CancelKeyVersionDeletionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // The OCID of the key version. KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CancelKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelKeyVersionDeletionRequest) String() string
CancelKeyVersionDeletionResponse wrapper for the CancelKeyVersionDeletion operation
type CancelKeyVersionDeletionResponse struct { // The underlying http response RawResponse *http.Response // The KeyVersion instance KeyVersion `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CancelKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelKeyVersionDeletionResponse) String() string
CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletionRequest.
type CancelVaultDeletionRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CancelVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelVaultDeletionRequest) String() string
CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation
type CancelVaultDeletionResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CancelVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelVaultDeletionResponse) String() string
ChangeKeyCompartmentDetails The representation of ChangeKeyCompartmentDetails
type ChangeKeyCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that you want to move the key to. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeKeyCompartmentDetails) String() string
ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartmentRequest.
type ChangeKeyCompartmentRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` ChangeKeyCompartmentDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeKeyCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeKeyCompartmentRequest) String() string
ChangeKeyCompartmentResponse wrapper for the ChangeKeyCompartment operation
type ChangeKeyCompartmentResponse struct { // The underlying http response RawResponse *http.Response // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeKeyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeKeyCompartmentResponse) String() string
ChangeVaultCompartmentDetails The representation of ChangeVaultCompartmentDetails
type ChangeVaultCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move the vault to. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeVaultCompartmentDetails) String() string
ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartmentRequest.
type ChangeVaultCompartmentRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` ChangeVaultCompartmentDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeVaultCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeVaultCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeVaultCompartmentRequest) String() string
ChangeVaultCompartmentResponse wrapper for the ChangeVaultCompartment operation
type ChangeVaultCompartmentResponse struct { // The underlying http response RawResponse *http.Response // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeVaultCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeVaultCompartmentResponse) String() string
CreateKeyDetails The representation of CreateKeyDetails
type CreateKeyDetails struct { // The OCID of the compartment where you want to create the master encryption key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A user-friendly name for the key. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` KeyShape *KeyShape `mandatory:"true" json:"keyShape"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. ProtectionMode CreateKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"` }
func (m CreateKeyDetails) String() string
CreateKeyDetailsProtectionModeEnum Enum with underlying type: string
type CreateKeyDetailsProtectionModeEnum string
Set of constants representing the allowable values for CreateKeyDetailsProtectionModeEnum
const ( CreateKeyDetailsProtectionModeHsm CreateKeyDetailsProtectionModeEnum = "HSM" CreateKeyDetailsProtectionModeSoftware CreateKeyDetailsProtectionModeEnum = "SOFTWARE" )
func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum
GetCreateKeyDetailsProtectionModeEnumValues Enumerates the set of values for CreateKeyDetailsProtectionModeEnum
CreateKeyRequest wrapper for the CreateKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKey.go.html to see an example of how to use CreateKeyRequest.
type CreateKeyRequest struct { // CreateKeyDetails CreateKeyDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKeyRequest) String() string
CreateKeyResponse wrapper for the CreateKey operation
type CreateKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKeyResponse) String() string
CreateKeyVersionRequest wrapper for the CreateKeyVersion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersionRequest.
type CreateKeyVersionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKeyVersionRequest) String() string
CreateKeyVersionResponse wrapper for the CreateKeyVersion operation
type CreateKeyVersionResponse struct { // The underlying http response RawResponse *http.Response // The KeyVersion instance KeyVersion `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKeyVersionResponse) String() string
CreateVaultDetails The representation of CreateVaultDetails
type CreateVaultDetails struct { // The OCID of the compartment where you want to create this vault. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A user-friendly name for the vault. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. VaultType CreateVaultDetailsVaultTypeEnum `mandatory:"true" json:"vaultType"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` }
func (m CreateVaultDetails) String() string
CreateVaultDetailsVaultTypeEnum Enum with underlying type: string
type CreateVaultDetailsVaultTypeEnum string
Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum
const ( CreateVaultDetailsVaultTypeVirtualPrivate CreateVaultDetailsVaultTypeEnum = "VIRTUAL_PRIVATE" CreateVaultDetailsVaultTypeDefault CreateVaultDetailsVaultTypeEnum = "DEFAULT" )
func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum
GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum
CreateVaultRequest wrapper for the CreateVault operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateVault.go.html to see an example of how to use CreateVaultRequest.
type CreateVaultRequest struct { // CreateVaultDetails CreateVaultDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateVaultRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVaultRequest) String() string
CreateVaultResponse wrapper for the CreateVault operation
type CreateVaultResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVaultResponse) String() string
DecryptDataDetails The representation of DecryptDataDetails
type DecryptDataDetails struct { // The encrypted data to decrypt. Ciphertext *string `mandatory:"true" json:"ciphertext"` // The OCID of the key used to encrypt the ciphertext. KeyId *string `mandatory:"true" json:"keyId"` // Information that can be used to provide an encryption context for the encrypted data. // The length of the string representation of the associated data must be fewer than 4096 characters. AssociatedData map[string]string `mandatory:"false" json:"associatedData"` // Information that provides context for audit logging. You can provide this additional // data as key-value pairs to include in audit logs when audit logging is enabled. LoggingContext map[string]string `mandatory:"false" json:"loggingContext"` // The OCID of the keyVersion used to encrypt the ciphertext. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Encryption algorithm to be used while encrypting/decrypting data using a customer key // AES_256_GCM is the supported value AES keys and uses GCM mode of operation // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. EncryptionAlgorithm DecryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"` }
func (m DecryptDataDetails) String() string
DecryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type DecryptDataDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for DecryptDataDetailsEncryptionAlgorithmEnum
const ( DecryptDataDetailsEncryptionAlgorithmAes256Gcm DecryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM" DecryptDataDetailsEncryptionAlgorithmRsaOaepSha1 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" DecryptDataDetailsEncryptionAlgorithmRsaOaepSha256 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum
GetDecryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptDataDetailsEncryptionAlgorithmEnum
DecryptRequest wrapper for the Decrypt operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Decrypt.go.html to see an example of how to use DecryptRequest.
type DecryptRequest struct { // DecryptDataDetails DecryptDataDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DecryptRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DecryptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DecryptRequest) String() string
DecryptResponse wrapper for the Decrypt operation
type DecryptResponse struct { // The underlying http response RawResponse *http.Response // The DecryptedData instance DecryptedData `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DecryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DecryptResponse) String() string
DecryptedData The representation of DecryptedData
type DecryptedData struct { // The decrypted data, expressed as a base64-encoded value. Plaintext *string `mandatory:"true" json:"plaintext"` // Checksum of the decrypted data. PlaintextChecksum *string `mandatory:"true" json:"plaintextChecksum"` // The OCID of the key used to encrypt the ciphertext. KeyId *string `mandatory:"false" json:"keyId"` // The OCID of the keyVersion used to encrypt the ciphertext. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Encryption algorithm to be used while encrypting/decrypting data using a customer key // AES_256_GCM is the supported value AES keys and uses GCM mode of operation // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. EncryptionAlgorithm DecryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"` }
func (m DecryptedData) String() string
DecryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
type DecryptedDataEncryptionAlgorithmEnum string
Set of constants representing the allowable values for DecryptedDataEncryptionAlgorithmEnum
const ( DecryptedDataEncryptionAlgorithmAes256Gcm DecryptedDataEncryptionAlgorithmEnum = "AES_256_GCM" DecryptedDataEncryptionAlgorithmRsaOaepSha1 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" DecryptedDataEncryptionAlgorithmRsaOaepSha256 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum
GetDecryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptedDataEncryptionAlgorithmEnum
DisableKeyRequest wrapper for the DisableKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/DisableKey.go.html to see an example of how to use DisableKeyRequest.
type DisableKeyRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DisableKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisableKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisableKeyRequest) String() string
DisableKeyResponse wrapper for the DisableKey operation
type DisableKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DisableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisableKeyResponse) String() string
EnableKeyRequest wrapper for the EnableKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/EnableKey.go.html to see an example of how to use EnableKeyRequest.
type EnableKeyRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request EnableKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EnableKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EnableKeyRequest) String() string
EnableKeyResponse wrapper for the EnableKey operation
type EnableKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response EnableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EnableKeyResponse) String() string
EncryptDataDetails The representation of EncryptDataDetails
type EncryptDataDetails struct { // The OCID of the key to encrypt with. KeyId *string `mandatory:"true" json:"keyId"` // The plaintext data to encrypt. Plaintext *string `mandatory:"true" json:"plaintext"` // Information that can be used to provide an encryption context for the // encrypted data. The length of the string representation of the associated data // must be fewer than 4096 characters. AssociatedData map[string]string `mandatory:"false" json:"associatedData"` // Information that provides context for audit logging. You can provide this additional // data as key-value pairs to include in the audit logs when audit logging is enabled. LoggingContext map[string]string `mandatory:"false" json:"loggingContext"` // The OCID of the keyVersion used to encrypt the ciphertext. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Encryption algorithm to be used while encrypting/decrypting data using a customer key // AES_256_GCM is the supported value AES keys and uses GCM mode of operation // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. EncryptionAlgorithm EncryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"` }
func (m EncryptDataDetails) String() string
EncryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type EncryptDataDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for EncryptDataDetailsEncryptionAlgorithmEnum
const ( EncryptDataDetailsEncryptionAlgorithmAes256Gcm EncryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM" EncryptDataDetailsEncryptionAlgorithmRsaOaepSha1 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" EncryptDataDetailsEncryptionAlgorithmRsaOaepSha256 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum
GetEncryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptDataDetailsEncryptionAlgorithmEnum
EncryptRequest wrapper for the Encrypt operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Encrypt.go.html to see an example of how to use EncryptRequest.
type EncryptRequest struct { // EncryptDataDetails EncryptDataDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request EncryptRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EncryptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EncryptRequest) String() string
EncryptResponse wrapper for the Encrypt operation
type EncryptResponse struct { // The underlying http response RawResponse *http.Response // The EncryptedData instance EncryptedData `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response EncryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EncryptResponse) String() string
EncryptedData The representation of EncryptedData
type EncryptedData struct { // The encrypted data. Ciphertext *string `mandatory:"true" json:"ciphertext"` // The OCID of the key used to sign the message KeyId *string `mandatory:"false" json:"keyId"` // The OCID of the keyVersion used to encrypt the ciphertext. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Encryption algorithm to be used while encrypting/decrypting data using a customer key // AES_256_GCM is the supported value AES keys and uses GCM mode of operation // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding. EncryptionAlgorithm EncryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"` }
func (m EncryptedData) String() string
EncryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
type EncryptedDataEncryptionAlgorithmEnum string
Set of constants representing the allowable values for EncryptedDataEncryptionAlgorithmEnum
const ( EncryptedDataEncryptionAlgorithmAes256Gcm EncryptedDataEncryptionAlgorithmEnum = "AES_256_GCM" EncryptedDataEncryptionAlgorithmRsaOaepSha1 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" EncryptedDataEncryptionAlgorithmRsaOaepSha256 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum
GetEncryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptedDataEncryptionAlgorithmEnum
ExportKeyDetails The details of the key that you want to wrap and export.
type ExportKeyDetails struct { // The OCID of the master encryption key associated with the key version you want to export. KeyId *string `mandatory:"true" json:"keyId"` // The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying `RSA_OAEP_AES_SHA256` // invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public // wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap // the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing // concatenated blob output that jointly represents them. Specifying `RSA_OAEP_SHA256` means that the software key is wrapped by // the RSA public wrapping key provided along with the request. Algorithm ExportKeyDetailsAlgorithmEnum `mandatory:"true" json:"algorithm"` // The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key. PublicKey *string `mandatory:"true" json:"publicKey"` // The OCID of the specific key version to export. If not specified, the service exports the current key version. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Information that provides context for audit logging. You can provide this additional // data as key-value pairs to include in the audit logs when audit logging is enabled. LoggingContext map[string]string `mandatory:"false" json:"loggingContext"` }
func (m ExportKeyDetails) String() string
ExportKeyDetailsAlgorithmEnum Enum with underlying type: string
type ExportKeyDetailsAlgorithmEnum string
Set of constants representing the allowable values for ExportKeyDetailsAlgorithmEnum
const ( ExportKeyDetailsAlgorithmAesSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_AES_SHA256" ExportKeyDetailsAlgorithmSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_SHA256" )
func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum
GetExportKeyDetailsAlgorithmEnumValues Enumerates the set of values for ExportKeyDetailsAlgorithmEnum
ExportKeyRequest wrapper for the ExportKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ExportKey.go.html to see an example of how to use ExportKeyRequest.
type ExportKeyRequest struct { // ExportKeyDetails ExportKeyDetails `contributesTo:"body"` // Unique Oracle-assigned identifier for the request. // If you need to contact Oracle about a particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ExportKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportKeyRequest) String() string
ExportKeyResponse wrapper for the ExportKey operation
type ExportKeyResponse struct { // The underlying http response RawResponse *http.Response // The ExportedKeyData instance ExportedKeyData `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ExportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportKeyResponse) String() string
ExportedKeyData The response to a request to export key material.
type ExportedKeyData struct { // The OCID of the key version. KeyVersionId *string `mandatory:"true" json:"keyVersionId"` // The OCID of the master encryption key associated with this key version. KeyId *string `mandatory:"true" json:"keyId"` // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains this key version. VaultId *string `mandatory:"true" json:"vaultId"` // The base64-encoded exported key material, which is encrypted by using the public RSA wrapping key specified in the export request. EncryptedKey *string `mandatory:"true" json:"encryptedKey"` // The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that // persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key // wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along // with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The // wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly // represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided // along with the request. Algorithm ExportedKeyDataAlgorithmEnum `mandatory:"true" json:"algorithm"` }
func (m ExportedKeyData) String() string
ExportedKeyDataAlgorithmEnum Enum with underlying type: string
type ExportedKeyDataAlgorithmEnum string
Set of constants representing the allowable values for ExportedKeyDataAlgorithmEnum
const ( ExportedKeyDataAlgorithmAesSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_AES_SHA256" ExportedKeyDataAlgorithmSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_SHA256" )
func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum
GetExportedKeyDataAlgorithmEnumValues Enumerates the set of values for ExportedKeyDataAlgorithmEnum
GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKeyRequest.
type GenerateDataEncryptionKeyRequest struct { // GenerateKeyDetails GenerateKeyDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GenerateDataEncryptionKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateDataEncryptionKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateDataEncryptionKeyRequest) String() string
GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation
type GenerateDataEncryptionKeyResponse struct { // The underlying http response RawResponse *http.Response // The GeneratedKey instance GeneratedKey `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GenerateDataEncryptionKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateDataEncryptionKeyResponse) String() string
GenerateKeyDetails The representation of GenerateKeyDetails
type GenerateKeyDetails struct { // If true, the generated key is also returned unencrypted. IncludePlaintextKey *bool `mandatory:"true" json:"includePlaintextKey"` // The OCID of the master encryption key to encrypt the generated data encryption key with. KeyId *string `mandatory:"true" json:"keyId"` KeyShape *KeyShape `mandatory:"true" json:"keyShape"` // Information that can be used to provide an encryption context for the encrypted data. // The length of the string representation of the associated data must be fewer than 4096 // characters. AssociatedData map[string]string `mandatory:"false" json:"associatedData"` // Information that provides context for audit logging. You can provide this additional // data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. LoggingContext map[string]string `mandatory:"false" json:"loggingContext"` }
func (m GenerateKeyDetails) String() string
GeneratedKey The representation of GeneratedKey
type GeneratedKey struct { // The encrypted data encryption key generated from a master encryption key. Ciphertext *string `mandatory:"true" json:"ciphertext"` // The plaintext data encryption key, a base64-encoded sequence of random bytes, which is // included if the GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) // request includes the `includePlaintextKey` parameter and sets its value to "true". Plaintext *string `mandatory:"false" json:"plaintext"` // The checksum of the plaintext data encryption key, which is included if the // GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) // request includes the `includePlaintextKey` parameter and sets its value to "true". PlaintextChecksum *string `mandatory:"false" json:"plaintextChecksum"` }
func (m GeneratedKey) String() string
GetKeyRequest wrapper for the GetKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKey.go.html to see an example of how to use GetKeyRequest.
type GetKeyRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKeyRequest) String() string
GetKeyResponse wrapper for the GetKey operation
type GetKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKeyResponse) String() string
GetKeyVersionRequest wrapper for the GetKeyVersion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersionRequest.
type GetKeyVersionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // The OCID of the key version. KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKeyVersionRequest) String() string
GetKeyVersionResponse wrapper for the GetKeyVersion operation
type GetKeyVersionResponse struct { // The underlying http response RawResponse *http.Response // The KeyVersion instance KeyVersion `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKeyVersionResponse) String() string
GetVaultRequest wrapper for the GetVault operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVault.go.html to see an example of how to use GetVaultRequest.
type GetVaultRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetVaultRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVaultRequest) String() string
GetVaultResponse wrapper for the GetVault operation
type GetVaultResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVaultResponse) String() string
GetVaultUsageRequest wrapper for the GetVaultUsage operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsageRequest.
type GetVaultUsageRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetVaultUsageRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVaultUsageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVaultUsageRequest) String() string
GetVaultUsageResponse wrapper for the GetVaultUsage operation
type GetVaultUsageResponse struct { // The underlying http response RawResponse *http.Response // The VaultUsage instance VaultUsage `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetVaultUsageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVaultUsageResponse) String() string
GetWrappingKeyRequest wrapper for the GetWrappingKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKeyRequest.
type GetWrappingKeyRequest struct { // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetWrappingKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWrappingKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWrappingKeyRequest) String() string
GetWrappingKeyResponse wrapper for the GetWrappingKey operation
type GetWrappingKeyResponse struct { // The underlying http response RawResponse *http.Response // The WrappingKey instance WrappingKey `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetWrappingKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWrappingKeyResponse) String() string
ImportKeyDetails The representation of ImportKeyDetails
type ImportKeyDetails struct { // The OCID of the compartment that contains this key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A user-friendly name for the key. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` KeyShape *KeyShape `mandatory:"true" json:"keyShape"` WrappedImportKey *WrappedImportKey `mandatory:"true" json:"wrappedImportKey"` // Usage of predefined tag keys. These predefined keys are scoped to namespaces. // Example: `{"foo-namespace": {"bar-key": "foo-value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Simple key-value pair that is applied without any predefined name, type, or scope. // Exists for cross-compatibility only. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. ProtectionMode ImportKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"` }
func (m ImportKeyDetails) String() string
ImportKeyDetailsProtectionModeEnum Enum with underlying type: string
type ImportKeyDetailsProtectionModeEnum string
Set of constants representing the allowable values for ImportKeyDetailsProtectionModeEnum
const ( ImportKeyDetailsProtectionModeHsm ImportKeyDetailsProtectionModeEnum = "HSM" ImportKeyDetailsProtectionModeSoftware ImportKeyDetailsProtectionModeEnum = "SOFTWARE" )
func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum
GetImportKeyDetailsProtectionModeEnumValues Enumerates the set of values for ImportKeyDetailsProtectionModeEnum
ImportKeyRequest wrapper for the ImportKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKey.go.html to see an example of how to use ImportKeyRequest.
type ImportKeyRequest struct { // ImportKeyDetails ImportKeyDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ImportKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportKeyRequest) String() string
ImportKeyResponse wrapper for the ImportKey operation
type ImportKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ImportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportKeyResponse) String() string
ImportKeyVersionDetails The representation of ImportKeyVersionDetails
type ImportKeyVersionDetails struct { WrappedImportKey *WrappedImportKey `mandatory:"true" json:"wrappedImportKey"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` }
func (m ImportKeyVersionDetails) String() string
ImportKeyVersionRequest wrapper for the ImportKeyVersion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersionRequest.
type ImportKeyVersionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // ImportKeyVersionDetails ImportKeyVersionDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ImportKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportKeyVersionRequest) String() string
ImportKeyVersionResponse wrapper for the ImportKeyVersion operation
type ImportKeyVersionResponse struct { // The underlying http response RawResponse *http.Response // The KeyVersion instance KeyVersion `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ImportKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportKeyVersionResponse) String() string
Key The representation of Key
type Key struct { // The OCID of the compartment that contains this master encryption key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The OCID of the key version used in cryptographic operations. During key rotation, the service might be // in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion` // property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations. CurrentKeyVersion *string `mandatory:"true" json:"currentKeyVersion"` // A user-friendly name for the key. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The OCID of the key. Id *string `mandatory:"true" json:"id"` KeyShape *KeyShape `mandatory:"true" json:"keyShape"` // The key's current lifecycle state. // Example: `ENABLED` LifecycleState KeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains this key. VaultId *string `mandatory:"true" json:"vaultId"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. ProtectionMode KeyProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"` // An optional property indicating when to delete the key, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2019-04-03T21:10:29.600Z` TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` // The OCID of the key from which this key was restored. RestoredFromKeyId *string `mandatory:"false" json:"restoredFromKeyId"` }
func (m Key) String() string
KeyLifecycleStateEnum Enum with underlying type: string
type KeyLifecycleStateEnum string
Set of constants representing the allowable values for KeyLifecycleStateEnum
const ( KeyLifecycleStateCreating KeyLifecycleStateEnum = "CREATING" KeyLifecycleStateEnabling KeyLifecycleStateEnum = "ENABLING" KeyLifecycleStateEnabled KeyLifecycleStateEnum = "ENABLED" KeyLifecycleStateDisabling KeyLifecycleStateEnum = "DISABLING" KeyLifecycleStateDisabled KeyLifecycleStateEnum = "DISABLED" KeyLifecycleStateDeleting KeyLifecycleStateEnum = "DELETING" KeyLifecycleStateDeleted KeyLifecycleStateEnum = "DELETED" KeyLifecycleStatePendingDeletion KeyLifecycleStateEnum = "PENDING_DELETION" KeyLifecycleStateSchedulingDeletion KeyLifecycleStateEnum = "SCHEDULING_DELETION" KeyLifecycleStateCancellingDeletion KeyLifecycleStateEnum = "CANCELLING_DELETION" KeyLifecycleStateUpdating KeyLifecycleStateEnum = "UPDATING" KeyLifecycleStateBackupInProgress KeyLifecycleStateEnum = "BACKUP_IN_PROGRESS" KeyLifecycleStateRestoring KeyLifecycleStateEnum = "RESTORING" )
func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum
GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum
KeyProtectionModeEnum Enum with underlying type: string
type KeyProtectionModeEnum string
Set of constants representing the allowable values for KeyProtectionModeEnum
const ( KeyProtectionModeHsm KeyProtectionModeEnum = "HSM" KeyProtectionModeSoftware KeyProtectionModeEnum = "SOFTWARE" )
func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum
GetKeyProtectionModeEnumValues Enumerates the set of values for KeyProtectionModeEnum
KeyShape The cryptographic properties of a key.
type KeyShape struct { // The algorithm used by a key's key versions to encrypt or decrypt. Algorithm KeyShapeAlgorithmEnum `mandatory:"true" json:"algorithm"` // The length of the key in bytes, expressed as an integer. Values supported: // - AES: 16, 24 or 32 // - RSA: 256, 384 or 512 // - ECDSA: 32, 48, 66 Length *int `mandatory:"true" json:"length"` // Supported curve Ids for ECDSA keys CurveId KeyShapeCurveIdEnum `mandatory:"false" json:"curveId,omitempty"` }
func (m KeyShape) String() string
KeyShapeAlgorithmEnum Enum with underlying type: string
type KeyShapeAlgorithmEnum string
Set of constants representing the allowable values for KeyShapeAlgorithmEnum
const ( KeyShapeAlgorithmAes KeyShapeAlgorithmEnum = "AES" KeyShapeAlgorithmRsa KeyShapeAlgorithmEnum = "RSA" KeyShapeAlgorithmEcdsa KeyShapeAlgorithmEnum = "ECDSA" )
func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum
GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum
KeyShapeCurveIdEnum Enum with underlying type: string
type KeyShapeCurveIdEnum string
Set of constants representing the allowable values for KeyShapeCurveIdEnum
const ( KeyShapeCurveIdP256 KeyShapeCurveIdEnum = "NIST_P256" KeyShapeCurveIdP384 KeyShapeCurveIdEnum = "NIST_P384" KeyShapeCurveIdP521 KeyShapeCurveIdEnum = "NIST_P521" )
func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum
GetKeyShapeCurveIdEnumValues Enumerates the set of values for KeyShapeCurveIdEnum
KeySummary The representation of KeySummary
type KeySummary struct { // The OCID of the compartment that contains the key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // A user-friendly name for the key. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The OCID of the key. Id *string `mandatory:"true" json:"id"` // The key's current lifecycle state. // Example: `ENABLED` LifecycleState KeySummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains the key. VaultId *string `mandatory:"true" json:"vaultId"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. ProtectionMode KeySummaryProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"` // The algorithm used by a key's key versions to encrypt or decrypt. Algorithm KeySummaryAlgorithmEnum `mandatory:"false" json:"algorithm,omitempty"` }
func (m KeySummary) String() string
KeySummaryAlgorithmEnum Enum with underlying type: string
type KeySummaryAlgorithmEnum string
Set of constants representing the allowable values for KeySummaryAlgorithmEnum
const ( KeySummaryAlgorithmAes KeySummaryAlgorithmEnum = "AES" KeySummaryAlgorithmRsa KeySummaryAlgorithmEnum = "RSA" KeySummaryAlgorithmEcdsa KeySummaryAlgorithmEnum = "ECDSA" )
func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum
GetKeySummaryAlgorithmEnumValues Enumerates the set of values for KeySummaryAlgorithmEnum
KeySummaryLifecycleStateEnum Enum with underlying type: string
type KeySummaryLifecycleStateEnum string
Set of constants representing the allowable values for KeySummaryLifecycleStateEnum
const ( KeySummaryLifecycleStateCreating KeySummaryLifecycleStateEnum = "CREATING" KeySummaryLifecycleStateEnabling KeySummaryLifecycleStateEnum = "ENABLING" KeySummaryLifecycleStateEnabled KeySummaryLifecycleStateEnum = "ENABLED" KeySummaryLifecycleStateDisabling KeySummaryLifecycleStateEnum = "DISABLING" KeySummaryLifecycleStateDisabled KeySummaryLifecycleStateEnum = "DISABLED" KeySummaryLifecycleStateDeleting KeySummaryLifecycleStateEnum = "DELETING" KeySummaryLifecycleStateDeleted KeySummaryLifecycleStateEnum = "DELETED" KeySummaryLifecycleStatePendingDeletion KeySummaryLifecycleStateEnum = "PENDING_DELETION" KeySummaryLifecycleStateSchedulingDeletion KeySummaryLifecycleStateEnum = "SCHEDULING_DELETION" KeySummaryLifecycleStateCancellingDeletion KeySummaryLifecycleStateEnum = "CANCELLING_DELETION" KeySummaryLifecycleStateUpdating KeySummaryLifecycleStateEnum = "UPDATING" KeySummaryLifecycleStateBackupInProgress KeySummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS" KeySummaryLifecycleStateRestoring KeySummaryLifecycleStateEnum = "RESTORING" )
func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum
GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum
KeySummaryProtectionModeEnum Enum with underlying type: string
type KeySummaryProtectionModeEnum string
Set of constants representing the allowable values for KeySummaryProtectionModeEnum
const ( KeySummaryProtectionModeHsm KeySummaryProtectionModeEnum = "HSM" KeySummaryProtectionModeSoftware KeySummaryProtectionModeEnum = "SOFTWARE" )
func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum
GetKeySummaryProtectionModeEnumValues Enumerates the set of values for KeySummaryProtectionModeEnum
KeyVersion The representation of KeyVersion
type KeyVersion struct { // The OCID of the compartment that contains this key version. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The OCID of the key version. Id *string `mandatory:"true" json:"id"` // The OCID of the key associated with this key version. KeyId *string `mandatory:"true" json:"keyId"` // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: "2018-04-03T21:10:29.600Z" TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains this key version. VaultId *string `mandatory:"true" json:"vaultId"` // The public key in PEM format which will be populated only in case of RSA and ECDSA keys. PublicKey *string `mandatory:"false" json:"publicKey"` // The key version's current lifecycle state. // Example: `ENABLED` LifecycleState KeyVersionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` // The source of the key material. When this value is `INTERNAL`, Key Management // created the key material. When this value is `EXTERNAL`, the key material // was imported from an external source. Origin KeyVersionOriginEnum `mandatory:"false" json:"origin,omitempty"` // An optional property indicating when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2019-04-03T21:10:29.600Z` TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` // The OCID of the key version from which this key version was restored. RestoredFromKeyVersionId *string `mandatory:"false" json:"restoredFromKeyVersionId"` }
func (m KeyVersion) String() string
KeyVersionLifecycleStateEnum Enum with underlying type: string
type KeyVersionLifecycleStateEnum string
Set of constants representing the allowable values for KeyVersionLifecycleStateEnum
const ( KeyVersionLifecycleStateCreating KeyVersionLifecycleStateEnum = "CREATING" KeyVersionLifecycleStateEnabling KeyVersionLifecycleStateEnum = "ENABLING" KeyVersionLifecycleStateEnabled KeyVersionLifecycleStateEnum = "ENABLED" KeyVersionLifecycleStateDisabling KeyVersionLifecycleStateEnum = "DISABLING" KeyVersionLifecycleStateDisabled KeyVersionLifecycleStateEnum = "DISABLED" KeyVersionLifecycleStateDeleting KeyVersionLifecycleStateEnum = "DELETING" KeyVersionLifecycleStateDeleted KeyVersionLifecycleStateEnum = "DELETED" KeyVersionLifecycleStatePendingDeletion KeyVersionLifecycleStateEnum = "PENDING_DELETION" KeyVersionLifecycleStateSchedulingDeletion KeyVersionLifecycleStateEnum = "SCHEDULING_DELETION" KeyVersionLifecycleStateCancellingDeletion KeyVersionLifecycleStateEnum = "CANCELLING_DELETION" )
func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum
GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum
KeyVersionOriginEnum Enum with underlying type: string
type KeyVersionOriginEnum string
Set of constants representing the allowable values for KeyVersionOriginEnum
const ( KeyVersionOriginInternal KeyVersionOriginEnum = "INTERNAL" KeyVersionOriginExternal KeyVersionOriginEnum = "EXTERNAL" )
func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum
GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum
KeyVersionSummary The representation of KeyVersionSummary
type KeyVersionSummary struct { // The OCID of the compartment that contains this key version. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The OCID of the key version. Id *string `mandatory:"true" json:"id"` // The OCID of the master encryption key associated with this key version. KeyId *string `mandatory:"true" json:"keyId"` // The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source. Origin KeyVersionSummaryOriginEnum `mandatory:"true" json:"origin"` // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains this key version. VaultId *string `mandatory:"true" json:"vaultId"` // The key version's current lifecycle state. // Example: `ENABLED` LifecycleState KeyVersionSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` // An optional property to indicate when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2019-04-03T21:10:29.600Z` TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` }
func (m KeyVersionSummary) String() string
KeyVersionSummaryLifecycleStateEnum Enum with underlying type: string
type KeyVersionSummaryLifecycleStateEnum string
Set of constants representing the allowable values for KeyVersionSummaryLifecycleStateEnum
const ( KeyVersionSummaryLifecycleStateCreating KeyVersionSummaryLifecycleStateEnum = "CREATING" KeyVersionSummaryLifecycleStateEnabling KeyVersionSummaryLifecycleStateEnum = "ENABLING" KeyVersionSummaryLifecycleStateEnabled KeyVersionSummaryLifecycleStateEnum = "ENABLED" KeyVersionSummaryLifecycleStateDisabling KeyVersionSummaryLifecycleStateEnum = "DISABLING" KeyVersionSummaryLifecycleStateDisabled KeyVersionSummaryLifecycleStateEnum = "DISABLED" KeyVersionSummaryLifecycleStateDeleting KeyVersionSummaryLifecycleStateEnum = "DELETING" KeyVersionSummaryLifecycleStateDeleted KeyVersionSummaryLifecycleStateEnum = "DELETED" KeyVersionSummaryLifecycleStatePendingDeletion KeyVersionSummaryLifecycleStateEnum = "PENDING_DELETION" KeyVersionSummaryLifecycleStateSchedulingDeletion KeyVersionSummaryLifecycleStateEnum = "SCHEDULING_DELETION" KeyVersionSummaryLifecycleStateCancellingDeletion KeyVersionSummaryLifecycleStateEnum = "CANCELLING_DELETION" )
func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum
GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum
KeyVersionSummaryOriginEnum Enum with underlying type: string
type KeyVersionSummaryOriginEnum string
Set of constants representing the allowable values for KeyVersionSummaryOriginEnum
const ( KeyVersionSummaryOriginInternal KeyVersionSummaryOriginEnum = "INTERNAL" KeyVersionSummaryOriginExternal KeyVersionSummaryOriginEnum = "EXTERNAL" )
func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum
GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum
KmsCryptoClient a client for KmsCrypto
type KmsCryptoClient struct { common.BaseClient // contains filtered or unexported fields }
func NewKmsCryptoClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsCryptoClient, err error)
NewKmsCryptoClientWithConfigurationProvider Creates a new default KmsCrypto client with the given configuration provider. the configuration provider will be used for the default signer
func NewKmsCryptoClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsCryptoClient, err error)
NewKmsCryptoClientWithOboToken Creates a new default KmsCrypto client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
func (client *KmsCryptoClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KmsCryptoClient) Decrypt(ctx context.Context, request DecryptRequest) (response DecryptResponse, err error)
Decrypt Decrypts data using the given DecryptDataDetails (https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Decrypt.go.html to see an example of how to use Decrypt API.
func (client KmsCryptoClient) Encrypt(ctx context.Context, request EncryptRequest) (response EncryptResponse, err error)
Encrypt Encrypts data using the given EncryptDataDetails (https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/EncryptDataDetails) resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Encrypt.go.html to see an example of how to use Encrypt API.
func (client KmsCryptoClient) ExportKey(ctx context.Context, request ExportKeyRequest) (response ExportKeyResponse, err error)
ExportKey Exports a specific version of a master encryption key according to the details of the request. For their protection, keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys stored on the server. For export, the key version is encrypted by an RSA public key that you provide.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ExportKey.go.html to see an example of how to use ExportKey API.
func (client KmsCryptoClient) GenerateDataEncryptionKey(ctx context.Context, request GenerateDataEncryptionKeyRequest) (response GenerateDataEncryptionKeyResponse, err error)
GenerateDataEncryptionKey Generates a key that you can use to encrypt or decrypt data.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKey API.
func (client KmsCryptoClient) Sign(ctx context.Context, request SignRequest) (response SignResponse, err error)
Sign Creates a digital signature for a message or message digest by using the private key in an asymmetric key. To verify the generated signature, you can use the Verify operation or use the public key in the same asymmetric key outside of KMS
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Sign.go.html to see an example of how to use Sign API.
func (client KmsCryptoClient) Verify(ctx context.Context, request VerifyRequest) (response VerifyResponse, err error)
Verify Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key. You can also verify the digital signature by using the public key in the asymmetric key outside of KMS
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Verify.go.html to see an example of how to use Verify API.
KmsManagementClient a client for KmsManagement
type KmsManagementClient struct { common.BaseClient // contains filtered or unexported fields }
func NewKmsManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsManagementClient, err error)
NewKmsManagementClientWithConfigurationProvider Creates a new default KmsManagement client with the given configuration provider. the configuration provider will be used for the default signer
func NewKmsManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsManagementClient, err error)
NewKmsManagementClientWithOboToken Creates a new default KmsManagement client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
func (client KmsManagementClient) BackupKey(ctx context.Context, request BackupKeyRequest) (response BackupKeyResponse, err error)
BackupKey Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupKey.go.html to see an example of how to use BackupKey API.
func (client KmsManagementClient) CancelKeyDeletion(ctx context.Context, request CancelKeyDeletionRequest) (response CancelKeyDeletionResponse, err error)
CancelKeyDeletion Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key's lifecycle state to what it was before its scheduled deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletion API.
func (client KmsManagementClient) CancelKeyVersionDeletion(ctx context.Context, request CancelKeyVersionDeletionRequest) (response CancelKeyVersionDeletionResponse, err error)
CancelKeyVersionDeletion Cancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletion API.
func (client KmsManagementClient) ChangeKeyCompartment(ctx context.Context, request ChangeKeyCompartmentRequest) (response ChangeKeyCompartmentResponse, err error)
ChangeKeyCompartment Moves a key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the key. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartment API.
func (client *KmsManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KmsManagementClient) CreateKey(ctx context.Context, request CreateKeyRequest) (response CreateKeyResponse, err error)
CreateKey Creates a new master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKey.go.html to see an example of how to use CreateKey API.
func (client KmsManagementClient) CreateKeyVersion(ctx context.Context, request CreateKeyVersionRequest) (response CreateKeyVersionResponse, err error)
CreateKeyVersion Generates a new KeyVersion (https://docs.cloud.oracle.com/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic material for a master encryption key. The key must be in an `ENABLED` state to be rotated. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersion API.
func (client KmsManagementClient) DisableKey(ctx context.Context, request DisableKeyRequest) (response DisableKeyResponse, err error)
DisableKey Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/DisableKey.go.html to see an example of how to use DisableKey API.
func (client KmsManagementClient) EnableKey(ctx context.Context, request EnableKeyRequest) (response EnableKeyResponse, err error)
EnableKey Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/EnableKey.go.html to see an example of how to use EnableKey API.
func (client KmsManagementClient) GetKey(ctx context.Context, request GetKeyRequest) (response GetKeyResponse, err error)
GetKey Gets information about the specified master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKey.go.html to see an example of how to use GetKey API.
func (client KmsManagementClient) GetKeyVersion(ctx context.Context, request GetKeyVersionRequest) (response GetKeyVersionResponse, err error)
GetKeyVersion Gets information about the specified key version. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersion API.
func (client KmsManagementClient) GetWrappingKey(ctx context.Context, request GetWrappingKeyRequest) (response GetWrappingKeyResponse, err error)
GetWrappingKey Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKey API.
func (client KmsManagementClient) ImportKey(ctx context.Context, request ImportKeyRequest) (response ImportKeyResponse, err error)
ImportKey Imports AES key material to create a new key with. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKey.go.html to see an example of how to use ImportKey API.
func (client KmsManagementClient) ImportKeyVersion(ctx context.Context, request ImportKeyVersionRequest) (response ImportKeyVersionResponse, err error)
ImportKeyVersion Imports AES key material to create a new key version with, and then rotates the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersion API.
func (client KmsManagementClient) ListKeyVersions(ctx context.Context, request ListKeyVersionsRequest) (response ListKeyVersionsResponse, err error)
ListKeyVersions Lists all KeyVersion (https://docs.cloud.oracle.com/api/#/en/key/latest/KeyVersion/) resources for the specified master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersions API.
func (client KmsManagementClient) ListKeys(ctx context.Context, request ListKeysRequest) (response ListKeysResponse, err error)
ListKeys Lists the master encryption keys in the specified vault and compartment. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeys.go.html to see an example of how to use ListKeys API.
func (client KmsManagementClient) RestoreKeyFromFile(ctx context.Context, request RestoreKeyFromFileRequest) (response RestoreKeyFromFileResponse, err error)
RestoreKeyFromFile Restores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFile API.
func (client KmsManagementClient) RestoreKeyFromObjectStore(ctx context.Context, request RestoreKeyFromObjectStoreRequest) (response RestoreKeyFromObjectStoreResponse, err error)
RestoreKeyFromObjectStore Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStore API.
func (client KmsManagementClient) ScheduleKeyDeletion(ctx context.Context, request ScheduleKeyDeletionRequest) (response ScheduleKeyDeletionResponse, err error)
ScheduleKeyDeletion Schedules the deletion of the specified key. This sets the lifecycle state of the key to `PENDING_DELETION` and then deletes it after the specified retention period ends. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletion API.
func (client KmsManagementClient) ScheduleKeyVersionDeletion(ctx context.Context, request ScheduleKeyVersionDeletionRequest) (response ScheduleKeyVersionDeletionResponse, err error)
ScheduleKeyVersionDeletion Schedules the deletion of the specified key version. This sets the lifecycle state of the key version to `PENDING_DELETION` and then deletes it after the specified retention period ends. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletion API.
func (client KmsManagementClient) UpdateKey(ctx context.Context, request UpdateKeyRequest) (response UpdateKeyResponse, err error)
UpdateKey Updates the properties of a master encryption key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the key must in an ENABLED or CREATING state to be updated. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKey API.
KmsVaultClient a client for KmsVault
type KmsVaultClient struct { common.BaseClient // contains filtered or unexported fields }
func NewKmsVaultClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client KmsVaultClient, err error)
NewKmsVaultClientWithConfigurationProvider Creates a new default KmsVault client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewKmsVaultClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client KmsVaultClient, err error)
NewKmsVaultClientWithOboToken Creates a new default KmsVault client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client KmsVaultClient) BackupVault(ctx context.Context, request BackupVaultRequest) (response BackupVaultResponse, err error)
BackupVault Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later. You can backup a vault whether or not it contains keys. This operation only backs up the metadata of the vault, and does not include key metadata.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupVault.go.html to see an example of how to use BackupVault API.
func (client KmsVaultClient) CancelVaultDeletion(ctx context.Context, request CancelVaultDeletionRequest) (response CancelVaultDeletionResponse, err error)
CancelVaultDeletion Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to their respective states from before their scheduled deletion. All keys that were scheduled for deletion prior to vault deletion retain their lifecycle state and time of deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletion API.
func (client KmsVaultClient) ChangeVaultCompartment(ctx context.Context, request ChangeVaultCompartmentRequest) (response ChangeVaultCompartmentResponse, err error)
ChangeVaultCompartment Moves a vault into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the resource. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartment API.
func (client *KmsVaultClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KmsVaultClient) CreateVault(ctx context.Context, request CreateVaultRequest) (response CreateVaultResponse, err error)
CreateVault Creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and either a dedicated hardware security module (HSM) or a multitenant HSM. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateVault.go.html to see an example of how to use CreateVault API.
func (client KmsVaultClient) GetVault(ctx context.Context, request GetVaultRequest) (response GetVaultResponse, err error)
GetVault Gets the specified vault's configuration information. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVault.go.html to see an example of how to use GetVault API.
func (client KmsVaultClient) GetVaultUsage(ctx context.Context, request GetVaultUsageRequest) (response GetVaultUsageResponse, err error)
GetVaultUsage Gets the count of keys and key versions in the specified vault to calculate usage against service limits.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsage API.
func (client KmsVaultClient) ListVaults(ctx context.Context, request ListVaultsRequest) (response ListVaultsResponse, err error)
ListVaults Lists the vaults in the specified compartment. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListVaults.go.html to see an example of how to use ListVaults API.
func (client KmsVaultClient) RestoreVaultFromFile(ctx context.Context, request RestoreVaultFromFileRequest) (response RestoreVaultFromFileResponse, err error)
RestoreVaultFromFile Restores a vault from an encrypted backup file. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFile API.
func (client KmsVaultClient) RestoreVaultFromObjectStore(ctx context.Context, request RestoreVaultFromObjectStoreRequest) (response RestoreVaultFromObjectStoreResponse, err error)
RestoreVaultFromObjectStore Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object Storage. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStore API.
func (client KmsVaultClient) ScheduleVaultDeletion(ctx context.Context, request ScheduleVaultDeletionRequest) (response ScheduleVaultDeletionResponse, err error)
ScheduleVaultDeletion Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it that are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't change. If any keys in the vault are scheduled to be deleted after the specified time of deletion for the vault, the call is rejected with the error code 409. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletion API.
func (client *KmsVaultClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client KmsVaultClient) UpdateVault(ctx context.Context, request UpdateVaultRequest) (response UpdateVaultResponse, err error)
UpdateVault Updates the properties of a vault. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the vault must be in an ACTIVE or CREATING state to be updated. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVault API.
ListKeyVersionsRequest wrapper for the ListKeyVersions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersionsRequest.
type ListKeyVersionsRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // The maximum number of items to return in a paginated "List" call. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header // from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The field to sort by. You can specify only one sort order. The default // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` // is ascending. SortBy ListKeyVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The sort order to use, either ascending (`ASC`) or descending (`DESC`). SortOrder ListKeyVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListKeyVersionsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKeyVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKeyVersionsRequest) String() string
ListKeyVersionsResponse wrapper for the ListKeyVersions operation
type ListKeyVersionsResponse struct { // The underlying http response RawResponse *http.Response // A list of []KeyVersionSummary instances Items []KeyVersionSummary `presentIn:"body"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then there are additional items still to get. Include this value as the `page` parameter for the // subsequent GET request. For information about pagination, see // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListKeyVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKeyVersionsResponse) String() string
ListKeyVersionsSortByEnum Enum with underlying type: string
type ListKeyVersionsSortByEnum string
Set of constants representing the allowable values for ListKeyVersionsSortByEnum
const ( ListKeyVersionsSortByTimecreated ListKeyVersionsSortByEnum = "TIMECREATED" ListKeyVersionsSortByDisplayname ListKeyVersionsSortByEnum = "DISPLAYNAME" )
func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum
GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum
ListKeyVersionsSortOrderEnum Enum with underlying type: string
type ListKeyVersionsSortOrderEnum string
Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum
const ( ListKeyVersionsSortOrderAsc ListKeyVersionsSortOrderEnum = "ASC" ListKeyVersionsSortOrderDesc ListKeyVersionsSortOrderEnum = "DESC" )
func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum
GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum
ListKeysAlgorithmEnum Enum with underlying type: string
type ListKeysAlgorithmEnum string
Set of constants representing the allowable values for ListKeysAlgorithmEnum
const ( ListKeysAlgorithmAes ListKeysAlgorithmEnum = "AES" ListKeysAlgorithmRsa ListKeysAlgorithmEnum = "RSA" ListKeysAlgorithmEcdsa ListKeysAlgorithmEnum = "ECDSA" )
func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum
GetListKeysAlgorithmEnumValues Enumerates the set of values for ListKeysAlgorithmEnum
ListKeysCurveIdEnum Enum with underlying type: string
type ListKeysCurveIdEnum string
Set of constants representing the allowable values for ListKeysCurveIdEnum
const ( ListKeysCurveIdP256 ListKeysCurveIdEnum = "NIST_P256" ListKeysCurveIdP384 ListKeysCurveIdEnum = "NIST_P384" ListKeysCurveIdP521 ListKeysCurveIdEnum = "NIST_P521" )
func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum
GetListKeysCurveIdEnumValues Enumerates the set of values for ListKeysCurveIdEnum
ListKeysProtectionModeEnum Enum with underlying type: string
type ListKeysProtectionModeEnum string
Set of constants representing the allowable values for ListKeysProtectionModeEnum
const ( ListKeysProtectionModeHsm ListKeysProtectionModeEnum = "HSM" ListKeysProtectionModeSoftware ListKeysProtectionModeEnum = "SOFTWARE" )
func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum
GetListKeysProtectionModeEnumValues Enumerates the set of values for ListKeysProtectionModeEnum
ListKeysRequest wrapper for the ListKeys operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeys.go.html to see an example of how to use ListKeysRequest.
type ListKeysRequest struct { // The OCID of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The maximum number of items to return in a paginated "List" call. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header // from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The field to sort by. You can specify only one sort order. The default // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` // is ascending. SortBy ListKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The sort order to use, either ascending (`ASC`) or descending (`DESC`). SortOrder ListKeysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A // protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are // performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's // RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of // `SOFTWARE` are performed on the server. ProtectionMode ListKeysProtectionModeEnum `mandatory:"false" contributesTo:"query" name:"protectionMode" omitEmpty:"true"` // The algorithm used by a key's key versions to encrypt or decrypt. Currently, only AES, RSA and ECDSA are supported. Algorithm ListKeysAlgorithmEnum `mandatory:"false" contributesTo:"query" name:"algorithm" omitEmpty:"true"` // The length of the key in bytes, expressed as an integer. Values of 16, 24, 32 are supported. Length *int `mandatory:"false" contributesTo:"query" name:"length"` // The curve Id of the keys in case of ECDSA keys CurveId ListKeysCurveIdEnum `mandatory:"false" contributesTo:"query" name:"curveId" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListKeysRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKeysRequest) String() string
ListKeysResponse wrapper for the ListKeys operation
type ListKeysResponse struct { // The underlying http response RawResponse *http.Response // A list of []KeySummary instances Items []KeySummary `presentIn:"body"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then there are additional items still to get. Include this value as the `page` parameter for the // subsequent GET request. For information about pagination, see // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKeysResponse) String() string
ListKeysSortByEnum Enum with underlying type: string
type ListKeysSortByEnum string
Set of constants representing the allowable values for ListKeysSortByEnum
const ( ListKeysSortByTimecreated ListKeysSortByEnum = "TIMECREATED" ListKeysSortByDisplayname ListKeysSortByEnum = "DISPLAYNAME" )
func GetListKeysSortByEnumValues() []ListKeysSortByEnum
GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum
ListKeysSortOrderEnum Enum with underlying type: string
type ListKeysSortOrderEnum string
Set of constants representing the allowable values for ListKeysSortOrderEnum
const ( ListKeysSortOrderAsc ListKeysSortOrderEnum = "ASC" ListKeysSortOrderDesc ListKeysSortOrderEnum = "DESC" )
func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum
GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum
ListVaultsRequest wrapper for the ListVaults operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListVaults.go.html to see an example of how to use ListVaultsRequest.
type ListVaultsRequest struct { // The OCID of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The maximum number of items to return in a paginated "List" call. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The value of the `opc-next-page` response header // from the previous "List" call. Page *string `mandatory:"false" contributesTo:"query" name:"page"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The field to sort by. You can specify only one sort order. The default // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` // is ascending. SortBy ListVaultsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The sort order to use, either ascending (`ASC`) or descending (`DESC`). SortOrder ListVaultsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListVaultsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVaultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVaultsRequest) String() string
ListVaultsResponse wrapper for the ListVaults operation
type ListVaultsResponse struct { // The underlying http response RawResponse *http.Response // A list of []VaultSummary instances Items []VaultSummary `presentIn:"body"` // For pagination of a list of items. When paging through a list, if this header appears in the response, // then there are additional items still to get. Include this value as the `page` parameter for the // subsequent GET request. For information about pagination, see // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListVaultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVaultsResponse) String() string
ListVaultsSortByEnum Enum with underlying type: string
type ListVaultsSortByEnum string
Set of constants representing the allowable values for ListVaultsSortByEnum
const ( ListVaultsSortByTimecreated ListVaultsSortByEnum = "TIMECREATED" ListVaultsSortByDisplayname ListVaultsSortByEnum = "DISPLAYNAME" )
func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum
GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum
ListVaultsSortOrderEnum Enum with underlying type: string
type ListVaultsSortOrderEnum string
Set of constants representing the allowable values for ListVaultsSortOrderEnum
const ( ListVaultsSortOrderAsc ListVaultsSortOrderEnum = "ASC" ListVaultsSortOrderDesc ListVaultsSortOrderEnum = "DESC" )
func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum
GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum
RestoreKeyFromFileRequest wrapper for the RestoreKeyFromFile operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFileRequest.
type RestoreKeyFromFileRequest struct { // The content length of the body. ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"` // The encrypted backup file to upload to restore the key. RestoreKeyFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15. // If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5 // hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and // a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5) // does not match the Content-MD5 header (HEADER_MD5)." ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request RestoreKeyFromFileRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreKeyFromFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreKeyFromFileRequest) String() string
RestoreKeyFromFileResponse wrapper for the RestoreKeyFromFile operation
type RestoreKeyFromFileResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // The base64-encoded MD5 hash value of the request body, as computed // by the server. OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // restore operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response RestoreKeyFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreKeyFromFileResponse) String() string
RestoreKeyFromObjectStoreDetails The representation of RestoreKeyFromObjectStoreDetails
type RestoreKeyFromObjectStoreDetails struct { BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"` }
func (m RestoreKeyFromObjectStoreDetails) String() string
func (m *RestoreKeyFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
RestoreKeyFromObjectStoreRequest wrapper for the RestoreKeyFromObjectStore operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStoreRequest.
type RestoreKeyFromObjectStoreRequest struct { // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Location to restore the backup from RestoreKeyFromObjectStoreDetails `contributesTo:"body"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request RestoreKeyFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreKeyFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreKeyFromObjectStoreRequest) String() string
RestoreKeyFromObjectStoreResponse wrapper for the RestoreKeyFromObjectStore operation
type RestoreKeyFromObjectStoreResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // restore operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response RestoreKeyFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreKeyFromObjectStoreResponse) String() string
RestoreVaultFromFileRequest wrapper for the RestoreVaultFromFile operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFileRequest.
type RestoreVaultFromFileRequest struct { // The OCID of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The content length of the body. ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"` // The encrypted backup file to upload to restore the vault. RestoreVaultFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15. // If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5 // hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and // a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5) // does not match the Content-MD5 header (HEADER_MD5)." ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request RestoreVaultFromFileRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreVaultFromFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreVaultFromFileRequest) String() string
RestoreVaultFromFileResponse wrapper for the RestoreVaultFromFile operation
type RestoreVaultFromFileResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // The base64-encoded MD5 hash value of the request body, as computed // by the server. OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // restore operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response RestoreVaultFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreVaultFromFileResponse) String() string
RestoreVaultFromObjectStoreDetails The representation of RestoreVaultFromObjectStoreDetails
type RestoreVaultFromObjectStoreDetails struct { BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"` }
func (m RestoreVaultFromObjectStoreDetails) String() string
func (m *RestoreVaultFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
RestoreVaultFromObjectStoreRequest wrapper for the RestoreVaultFromObjectStore operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStoreRequest.
type RestoreVaultFromObjectStoreRequest struct { // The OCID of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // RestoreVaultFromObjectStoreDetails RestoreVaultFromObjectStoreDetails `contributesTo:"body"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request RestoreVaultFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreVaultFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreVaultFromObjectStoreRequest) String() string
RestoreVaultFromObjectStoreResponse wrapper for the RestoreVaultFromObjectStore operation
type RestoreVaultFromObjectStoreResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // Unique Oracle-assigned identifier for the work request, used to track the progress of the // restore operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` }
func (response RestoreVaultFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreVaultFromObjectStoreResponse) String() string
ScheduleKeyDeletionDetails Details for scheduling key deletion.
type ScheduleKeyDeletionDetails struct { // An optional property to indicate when to delete the vault, expressed in // RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified // time must be between 7 and 30 days from when the request is received. // If this property is missing, it will be set to 30 days from the time of the request // by default. TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` }
func (m ScheduleKeyDeletionDetails) String() string
ScheduleKeyDeletionRequest wrapper for the ScheduleKeyDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletionRequest.
type ScheduleKeyDeletionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // ScheduleKeyDeletionDetails ScheduleKeyDeletionDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ScheduleKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleKeyDeletionRequest) String() string
ScheduleKeyDeletionResponse wrapper for the ScheduleKeyDeletion operation
type ScheduleKeyDeletionResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ScheduleKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleKeyDeletionResponse) String() string
ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.
type ScheduleKeyVersionDeletionDetails struct { // An optional property to indicate when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) // timestamp format. The specified time must be between 7 and 30 days from the time // when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` }
func (m ScheduleKeyVersionDeletionDetails) String() string
ScheduleKeyVersionDeletionRequest wrapper for the ScheduleKeyVersionDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletionRequest.
type ScheduleKeyVersionDeletionRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // The OCID of the key version. KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"` // ScheduleKeyVersionDeletionDetails ScheduleKeyVersionDeletionDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ScheduleKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleKeyVersionDeletionRequest) String() string
ScheduleKeyVersionDeletionResponse wrapper for the ScheduleKeyVersionDeletion operation
type ScheduleKeyVersionDeletionResponse struct { // The underlying http response RawResponse *http.Response // The KeyVersion instance KeyVersion `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ScheduleKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleKeyVersionDeletionResponse) String() string
ScheduleVaultDeletionDetails Details for scheduling vault deletion.
type ScheduleVaultDeletionDetails struct { // An optional property indicating when to delete the vault, expressed in // RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified // time must be between 7 and 30 days from the time when the request is received. // If this property is missing, it will be set to 30 days from the time of the request // by default. TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` }
func (m ScheduleVaultDeletionDetails) String() string
ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletionRequest.
type ScheduleVaultDeletionRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // ScheduleVaultDeletionDetails ScheduleVaultDeletionDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case // of a timeout or server error without risk of executing that same action // again. Retry tokens expire after 24 hours, but can be invalidated // before then due to conflicting operations (e.g., if a resource has been // deleted and purged from the system, then a retry of the original // creation request may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ScheduleVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleVaultDeletionRequest) String() string
ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation
type ScheduleVaultDeletionResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ScheduleVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleVaultDeletionResponse) String() string
SignDataDetails The representation of SignDataDetails
type SignDataDetails struct { // The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. Message *string `mandatory:"true" json:"message"` // The OCID of the key used to sign the message KeyId *string `mandatory:"true" json:"keyId"` // The algorithm to be used for signing the message or message digest // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with // different Hashing algorithms. // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. // In case of passing digest for signing, make sure the same hashing algorithm is // specified as used for created for digest. SigningAlgorithm SignDataDetailsSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"` // The OCID of the keyVersion used to sign the message. KeyVersionId *string `mandatory:"false" json:"keyVersionId"` // Denotes whether the value of the message parameter is a raw message or a message digest. // The default value, RAW, indicates a message. To indicate a message digest, use DIGEST. MessageType SignDataDetailsMessageTypeEnum `mandatory:"false" json:"messageType,omitempty"` }
func (m SignDataDetails) String() string
SignDataDetailsMessageTypeEnum Enum with underlying type: string
type SignDataDetailsMessageTypeEnum string
Set of constants representing the allowable values for SignDataDetailsMessageTypeEnum
const ( SignDataDetailsMessageTypeRaw SignDataDetailsMessageTypeEnum = "RAW" SignDataDetailsMessageTypeDigest SignDataDetailsMessageTypeEnum = "DIGEST" )
func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum
GetSignDataDetailsMessageTypeEnumValues Enumerates the set of values for SignDataDetailsMessageTypeEnum
SignDataDetailsSigningAlgorithmEnum Enum with underlying type: string
type SignDataDetailsSigningAlgorithmEnum string
Set of constants representing the allowable values for SignDataDetailsSigningAlgorithmEnum
const ( SignDataDetailsSigningAlgorithmSha224RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS" SignDataDetailsSigningAlgorithmSha256RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS" SignDataDetailsSigningAlgorithmSha384RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS" SignDataDetailsSigningAlgorithmSha512RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS" SignDataDetailsSigningAlgorithmSha224RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5" SignDataDetailsSigningAlgorithmSha256RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5" SignDataDetailsSigningAlgorithmSha384RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5" SignDataDetailsSigningAlgorithmSha512RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5" SignDataDetailsSigningAlgorithmEcdsaSha256 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256" SignDataDetailsSigningAlgorithmEcdsaSha384 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384" SignDataDetailsSigningAlgorithmEcdsaSha512 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512" )
func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum
GetSignDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for SignDataDetailsSigningAlgorithmEnum
SignRequest wrapper for the Sign operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Sign.go.html to see an example of how to use SignRequest.
type SignRequest struct { // SignDataDetails SignDataDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request SignRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SignRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SignRequest) String() string
SignResponse wrapper for the Sign operation
type SignResponse struct { // The underlying http response RawResponse *http.Response // The SignedData instance SignedData `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response SignResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SignResponse) String() string
SignedData The representation of SignedData
type SignedData struct { // The OCID of the key used to sign the message KeyId *string `mandatory:"true" json:"keyId"` // The OCID of the keyVersion used to sign the message KeyVersionId *string `mandatory:"true" json:"keyVersionId"` // The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest. Signature *string `mandatory:"true" json:"signature"` // The algorithm to be used for signing the message or message digest // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with // different Hashing algorithms. // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. // In case of passing digest for signing, make sure the same hashing algorithm is // specified as used for created for digest. SigningAlgorithm SignedDataSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"` }
func (m SignedData) String() string
SignedDataSigningAlgorithmEnum Enum with underlying type: string
type SignedDataSigningAlgorithmEnum string
Set of constants representing the allowable values for SignedDataSigningAlgorithmEnum
const ( SignedDataSigningAlgorithmSha224RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS" SignedDataSigningAlgorithmSha256RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS" SignedDataSigningAlgorithmSha384RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS" SignedDataSigningAlgorithmSha512RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS" SignedDataSigningAlgorithmSha224RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5" SignedDataSigningAlgorithmSha256RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5" SignedDataSigningAlgorithmSha384RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5" SignedDataSigningAlgorithmSha512RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5" SignedDataSigningAlgorithmEcdsaSha256 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_256" SignedDataSigningAlgorithmEcdsaSha384 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_384" SignedDataSigningAlgorithmEcdsaSha512 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_512" )
func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum
GetSignedDataSigningAlgorithmEnumValues Enumerates the set of values for SignedDataSigningAlgorithmEnum
UpdateKeyDetails The representation of UpdateKeyDetails
type UpdateKeyDetails struct { // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // A user-friendly name for the key. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` }
func (m UpdateKeyDetails) String() string
UpdateKeyRequest wrapper for the UpdateKey operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKeyRequest.
type UpdateKeyRequest struct { // The OCID of the key. KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"` // UpdateKeyDetails UpdateKeyDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateKeyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateKeyRequest) String() string
UpdateKeyResponse wrapper for the UpdateKey operation
type UpdateKeyResponse struct { // The underlying http response RawResponse *http.Response // The Key instance Key `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateKeyResponse) String() string
UpdateVaultDetails The representation of UpdateVaultDetails
type UpdateVaultDetails struct { // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // A user-friendly name for the vault. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` }
func (m UpdateVaultDetails) String() string
UpdateVaultRequest wrapper for the UpdateVault operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVaultRequest.
type UpdateVaultRequest struct { // The OCID of the vault. VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"` // UpdateVaultDetails UpdateVaultDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call for a // resource, set the `if-match` parameter to the value of the etag from a // previous GET or POST response for that resource. The resource will be // updated or deleted only if the etag you provide matches the resource's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateVaultRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVaultRequest) String() string
UpdateVaultResponse wrapper for the UpdateVault operation
type UpdateVaultResponse struct { // The underlying http response RawResponse *http.Response // The Vault instance Vault `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVaultResponse) String() string
Vault The representation of Vault
type Vault struct { // The OCID of the compartment that contains this vault. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The service endpoint to perform cryptographic operations against. Cryptographic operations include // Encrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/DecryptedData/Decrypt), // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. CryptoEndpoint *string `mandatory:"true" json:"cryptoEndpoint"` // A user-friendly name for the vault. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The OCID of the vault. Id *string `mandatory:"true" json:"id"` // The vault's current lifecycle state. // Example: `DELETED` LifecycleState VaultLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. ManagementEndpoint *string `mandatory:"true" json:"managementEndpoint"` // The date and time this vault was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The type of vault. Each type of vault stores the key with different // degrees of isolation and has different options and pricing. VaultType VaultVaultTypeEnum `mandatory:"true" json:"vaultType"` // The OCID of the vault's wrapping key. WrappingkeyId *string `mandatory:"true" json:"wrappingkeyId"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // An optional property to indicate when to delete the vault, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"` // The OCID of the vault from which this vault was restored, if it was restored from a backup file. // If you restore a vault to the same region, the vault retains the same OCID that it had when you // backed up the vault. RestoredFromVaultId *string `mandatory:"false" json:"restoredFromVaultId"` }
func (m Vault) String() string
VaultLifecycleStateEnum Enum with underlying type: string
type VaultLifecycleStateEnum string
Set of constants representing the allowable values for VaultLifecycleStateEnum
const ( VaultLifecycleStateCreating VaultLifecycleStateEnum = "CREATING" VaultLifecycleStateActive VaultLifecycleStateEnum = "ACTIVE" VaultLifecycleStateDeleting VaultLifecycleStateEnum = "DELETING" VaultLifecycleStateDeleted VaultLifecycleStateEnum = "DELETED" VaultLifecycleStatePendingDeletion VaultLifecycleStateEnum = "PENDING_DELETION" VaultLifecycleStateSchedulingDeletion VaultLifecycleStateEnum = "SCHEDULING_DELETION" VaultLifecycleStateCancellingDeletion VaultLifecycleStateEnum = "CANCELLING_DELETION" VaultLifecycleStateUpdating VaultLifecycleStateEnum = "UPDATING" VaultLifecycleStateBackupInProgress VaultLifecycleStateEnum = "BACKUP_IN_PROGRESS" VaultLifecycleStateRestoring VaultLifecycleStateEnum = "RESTORING" )
func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum
GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum
VaultSummary The representation of VaultSummary
type VaultSummary struct { // The OCID of the compartment that contains a particular vault. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The service endpoint to perform cryptographic operations against. Cryptographic operations include // Encrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/DecryptedData/Decrypt), // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. CryptoEndpoint *string `mandatory:"true" json:"cryptoEndpoint"` // A user-friendly name for a vault. It does not have to be unique, and it is changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The OCID of a vault. Id *string `mandatory:"true" json:"id"` // A vault's current lifecycle state. // Example: `ACTIVE` LifecycleState VaultSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. ManagementEndpoint *string `mandatory:"true" json:"managementEndpoint"` // The date and time a vault was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The type of vault. Each type of vault stores keys with different // degrees of isolation and has different options and pricing. VaultType VaultSummaryVaultTypeEnum `mandatory:"true" json:"vaultType"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` }
func (m VaultSummary) String() string
VaultSummaryLifecycleStateEnum Enum with underlying type: string
type VaultSummaryLifecycleStateEnum string
Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum
const ( VaultSummaryLifecycleStateCreating VaultSummaryLifecycleStateEnum = "CREATING" VaultSummaryLifecycleStateActive VaultSummaryLifecycleStateEnum = "ACTIVE" VaultSummaryLifecycleStateDeleting VaultSummaryLifecycleStateEnum = "DELETING" VaultSummaryLifecycleStateDeleted VaultSummaryLifecycleStateEnum = "DELETED" VaultSummaryLifecycleStatePendingDeletion VaultSummaryLifecycleStateEnum = "PENDING_DELETION" VaultSummaryLifecycleStateSchedulingDeletion VaultSummaryLifecycleStateEnum = "SCHEDULING_DELETION" VaultSummaryLifecycleStateCancellingDeletion VaultSummaryLifecycleStateEnum = "CANCELLING_DELETION" VaultSummaryLifecycleStateUpdating VaultSummaryLifecycleStateEnum = "UPDATING" VaultSummaryLifecycleStateBackupInProgress VaultSummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS" VaultSummaryLifecycleStateRestoring VaultSummaryLifecycleStateEnum = "RESTORING" )
func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum
GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum
VaultSummaryVaultTypeEnum Enum with underlying type: string
type VaultSummaryVaultTypeEnum string
Set of constants representing the allowable values for VaultSummaryVaultTypeEnum
const ( VaultSummaryVaultTypeVirtualPrivate VaultSummaryVaultTypeEnum = "VIRTUAL_PRIVATE" VaultSummaryVaultTypeDefault VaultSummaryVaultTypeEnum = "DEFAULT" )
func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum
GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum
VaultUsage The representation of VaultUsage
type VaultUsage struct { // The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a `DELETED` state. KeyCount *int `mandatory:"true" json:"keyCount"` // The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a `DELETED` state. KeyVersionCount *int `mandatory:"true" json:"keyVersionCount"` // The number of keys in this vault that persist on the server, across all compartments, excluding keys in a `DELETED` state. SoftwareKeyCount *int `mandatory:"false" json:"softwareKeyCount"` // The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a `DELETED` state. SoftwareKeyVersionCount *int `mandatory:"false" json:"softwareKeyVersionCount"` }
func (m VaultUsage) String() string
VaultVaultTypeEnum Enum with underlying type: string
type VaultVaultTypeEnum string
Set of constants representing the allowable values for VaultVaultTypeEnum
const ( VaultVaultTypeVirtualPrivate VaultVaultTypeEnum = "VIRTUAL_PRIVATE" VaultVaultTypeDefault VaultVaultTypeEnum = "DEFAULT" )
func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum
GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum
VerifiedData The representation of VerifiedData
type VerifiedData struct { // A Boolean value that indicates whether the signature was verified. IsSignatureValid *bool `mandatory:"true" json:"isSignatureValid"` }
func (m VerifiedData) String() string
VerifyDataDetails The representation of VerifyDataDetails
type VerifyDataDetails struct { // The OCID of the key used to sign the message KeyId *string `mandatory:"true" json:"keyId"` // The OCID of the keyVersion used to sign the message KeyVersionId *string `mandatory:"true" json:"keyVersionId"` // The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message. Signature *string `mandatory:"true" json:"signature"` // The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest. Message *string `mandatory:"true" json:"message"` // The algorithm to be used for signing the message or message digest // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with // different Hashing algorithms. // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. // In case of passing digest for signing, make sure the same hashing algorithm is // specified as used for created for digest. SigningAlgorithm VerifyDataDetailsSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"` // Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST. MessageType VerifyDataDetailsMessageTypeEnum `mandatory:"false" json:"messageType,omitempty"` }
func (m VerifyDataDetails) String() string
VerifyDataDetailsMessageTypeEnum Enum with underlying type: string
type VerifyDataDetailsMessageTypeEnum string
Set of constants representing the allowable values for VerifyDataDetailsMessageTypeEnum
const ( VerifyDataDetailsMessageTypeRaw VerifyDataDetailsMessageTypeEnum = "RAW" VerifyDataDetailsMessageTypeDigest VerifyDataDetailsMessageTypeEnum = "DIGEST" )
func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum
GetVerifyDataDetailsMessageTypeEnumValues Enumerates the set of values for VerifyDataDetailsMessageTypeEnum
VerifyDataDetailsSigningAlgorithmEnum Enum with underlying type: string
type VerifyDataDetailsSigningAlgorithmEnum string
Set of constants representing the allowable values for VerifyDataDetailsSigningAlgorithmEnum
const ( VerifyDataDetailsSigningAlgorithmSha224RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS" VerifyDataDetailsSigningAlgorithmSha256RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS" VerifyDataDetailsSigningAlgorithmSha384RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS" VerifyDataDetailsSigningAlgorithmSha512RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS" VerifyDataDetailsSigningAlgorithmSha224RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5" VerifyDataDetailsSigningAlgorithmSha256RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5" VerifyDataDetailsSigningAlgorithmSha384RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5" VerifyDataDetailsSigningAlgorithmSha512RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5" VerifyDataDetailsSigningAlgorithmEcdsaSha256 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256" VerifyDataDetailsSigningAlgorithmEcdsaSha384 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384" VerifyDataDetailsSigningAlgorithmEcdsaSha512 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512" )
func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum
GetVerifyDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for VerifyDataDetailsSigningAlgorithmEnum
VerifyRequest wrapper for the Verify operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Verify.go.html to see an example of how to use VerifyRequest.
type VerifyRequest struct { // VerifyDataDetails VerifyDataDetails `contributesTo:"body"` // Unique identifier for the request. If provided, the returned request ID // will include this value. Otherwise, a random request ID will be // generated by the service. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request VerifyRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request VerifyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request VerifyRequest) String() string
VerifyResponse wrapper for the Verify operation
type VerifyResponse struct { // The underlying http response RawResponse *http.Response // The VerifiedData instance VerifiedData `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response VerifyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response VerifyResponse) String() string
WrappedImportKey The representation of WrappedImportKey
type WrappedImportKey struct { // The key material to import, wrapped by the vault's public RSA wrapping key and base64-encoded. KeyMaterial *string `mandatory:"true" json:"keyMaterial"` // The wrapping mechanism to use during key import. // RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped // by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. // The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. // RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key. WrappingAlgorithm WrappedImportKeyWrappingAlgorithmEnum `mandatory:"true" json:"wrappingAlgorithm"` }
func (m WrappedImportKey) String() string
WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string
type WrappedImportKeyWrappingAlgorithmEnum string
Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum
const ( WrappedImportKeyWrappingAlgorithmSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256" WrappedImportKeyWrappingAlgorithmAesSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_AES_SHA256" )
func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum
GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum
WrappingKey The representation of WrappingKey
type WrappingKey struct { // The OCID of the compartment that contains this key. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The OCID of the key. Id *string `mandatory:"true" json:"id"` // The key's current lifecycle state. // Example: `ENABLED` LifecycleState WrappingKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The public key, in PEM format, to use to wrap the key material before importing it. PublicKey *string `mandatory:"true" json:"publicKey"` // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. // Example: `2018-04-03T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The OCID of the vault that contains this key. VaultId *string `mandatory:"true" json:"vaultId"` }
func (m WrappingKey) String() string
WrappingKeyLifecycleStateEnum Enum with underlying type: string
type WrappingKeyLifecycleStateEnum string
Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum
const ( WrappingKeyLifecycleStateCreating WrappingKeyLifecycleStateEnum = "CREATING" WrappingKeyLifecycleStateEnabling WrappingKeyLifecycleStateEnum = "ENABLING" WrappingKeyLifecycleStateEnabled WrappingKeyLifecycleStateEnum = "ENABLED" WrappingKeyLifecycleStateDisabling WrappingKeyLifecycleStateEnum = "DISABLING" WrappingKeyLifecycleStateDisabled WrappingKeyLifecycleStateEnum = "DISABLED" WrappingKeyLifecycleStateDeleting WrappingKeyLifecycleStateEnum = "DELETING" WrappingKeyLifecycleStateDeleted WrappingKeyLifecycleStateEnum = "DELETED" WrappingKeyLifecycleStatePendingDeletion WrappingKeyLifecycleStateEnum = "PENDING_DELETION" WrappingKeyLifecycleStateSchedulingDeletion WrappingKeyLifecycleStateEnum = "SCHEDULING_DELETION" WrappingKeyLifecycleStateCancellingDeletion WrappingKeyLifecycleStateEnum = "CANCELLING_DELETION" WrappingKeyLifecycleStateUpdating WrappingKeyLifecycleStateEnum = "UPDATING" WrappingKeyLifecycleStateBackupInProgress WrappingKeyLifecycleStateEnum = "BACKUP_IN_PROGRESS" WrappingKeyLifecycleStateRestoring WrappingKeyLifecycleStateEnum = "RESTORING" )
func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum
GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum