vault

package
v38.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 6, 2021 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Base64SecretContentDetails 

type Base64SecretContentDetails struct {

	// Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
	Name *string `mandatory:"false" json:"name"`

	// The base64-encoded content of the secret.
	Content *string `mandatory:"false" json:"content"`

	// The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version
	// that you mark as `PENDING` is staged and available for use, but you don't yet want to rotate it into current, active use. For example,
	// you might create or update a secret and mark its rotation state as `PENDING` if you haven't yet updated the secret on the target system.
	// When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating
	// a secret, you can specify a version's rotation state as either `CURRENT` or `PENDING`.
	Stage SecretContentDetailsStageEnum `mandatory:"false" json:"stage,omitempty"`
}

Base64SecretContentDetails Base64-encoded secret content.

func (Base64SecretContentDetails) GetName 

func (m Base64SecretContentDetails) GetName() *string

GetName returns Name

func (Base64SecretContentDetails) GetStage 

func (m Base64SecretContentDetails) GetStage() SecretContentDetailsStageEnum

GetStage returns Stage

func (Base64SecretContentDetails) MarshalJSON 

func (m Base64SecretContentDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (Base64SecretContentDetails) String 

func (m Base64SecretContentDetails) String() string

type CancelSecretDeletionRequest 

type CancelSecretDeletionRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// 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
}

CancelSecretDeletionRequest wrapper for the CancelSecretDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CancelSecretDeletion.go.html to see an example of how to use CancelSecretDeletionRequest.

func (CancelSecretDeletionRequest) HTTPRequest 

func (request CancelSecretDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelSecretDeletionRequest) RetryPolicy 

func (request CancelSecretDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelSecretDeletionRequest) String 

func (request CancelSecretDeletionRequest) String() string

type CancelSecretDeletionResponse 

type CancelSecretDeletionResponse 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"`
}

CancelSecretDeletionResponse wrapper for the CancelSecretDeletion operation

func (CancelSecretDeletionResponse) HTTPResponse 

func (response CancelSecretDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelSecretDeletionResponse) String 

func (response CancelSecretDeletionResponse) String() string

type CancelSecretVersionDeletionRequest 

type CancelSecretVersionDeletionRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// The version number of the secret.
	SecretVersionNumber *int64 `mandatory:"true" contributesTo:"path" name:"secretVersionNumber"`

	// 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
}

CancelSecretVersionDeletionRequest wrapper for the CancelSecretVersionDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CancelSecretVersionDeletion.go.html to see an example of how to use CancelSecretVersionDeletionRequest.

func (CancelSecretVersionDeletionRequest) HTTPRequest 

func (request CancelSecretVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelSecretVersionDeletionRequest) RetryPolicy 

func (request CancelSecretVersionDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelSecretVersionDeletionRequest) String 

func (request CancelSecretVersionDeletionRequest) String() string

type CancelSecretVersionDeletionResponse 

type CancelSecretVersionDeletionResponse 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"`
}

CancelSecretVersionDeletionResponse wrapper for the CancelSecretVersionDeletion operation

func (CancelSecretVersionDeletionResponse) HTTPResponse 

func (response CancelSecretVersionDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelSecretVersionDeletionResponse) String 

func (response CancelSecretVersionDeletionResponse) String() string

type ChangeSecretCompartmentDetails 

type ChangeSecretCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeSecretCompartmentDetails Specifies the updated compartment OCID for the secret.

func (ChangeSecretCompartmentDetails) String 

func (m ChangeSecretCompartmentDetails) String() string

type ChangeSecretCompartmentRequest 

type ChangeSecretCompartmentRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// The updated compartment details.
	ChangeSecretCompartmentDetails `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
}

ChangeSecretCompartmentRequest wrapper for the ChangeSecretCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ChangeSecretCompartment.go.html to see an example of how to use ChangeSecretCompartmentRequest.

func (ChangeSecretCompartmentRequest) HTTPRequest 

func (request ChangeSecretCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeSecretCompartmentRequest) RetryPolicy 

func (request ChangeSecretCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeSecretCompartmentRequest) String 

func (request ChangeSecretCompartmentRequest) String() string

type ChangeSecretCompartmentResponse 

type ChangeSecretCompartmentResponse 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"`
}

ChangeSecretCompartmentResponse wrapper for the ChangeSecretCompartment operation

func (ChangeSecretCompartmentResponse) HTTPResponse 

func (response ChangeSecretCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeSecretCompartmentResponse) String 

func (response ChangeSecretCompartmentResponse) String() string

type CreateSecretDetails 

type CreateSecretDetails struct {

	// The OCID of the compartment where you want to create the secret.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	SecretContent SecretContentDetails `mandatory:"true" json:"secretContent"`

	// A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
	SecretName *string `mandatory:"true" json:"secretName"`

	// The OCID of the vault where you want to create the secret.
	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"`

	// A brief description of the secret. Avoid entering confidential information.
	Description *string `mandatory:"false" json:"description"`

	// 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 OCID of the master encryption key that is used to encrypt the secret.
	KeyId *string `mandatory:"false" json:"keyId"`

	// Additional metadata that you can use to provide context about how to use the secret during rotation or
	// other administrative tasks. For example, for a secret that you use to connect to a database, the additional
	// metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.
	Metadata map[string]interface{} `mandatory:"false" json:"metadata"`

	// A list of rules to control how the secret is used and managed.
	SecretRules []SecretRule `mandatory:"false" json:"secretRules"`
}

CreateSecretDetails The details of the secret that you want to create.

func (CreateSecretDetails) String 

func (m CreateSecretDetails) String() string

func (*CreateSecretDetails) UnmarshalJSON 

func (m *CreateSecretDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type CreateSecretRequest 

type CreateSecretRequest struct {

	// Request to create a new secret.
	CreateSecretDetails `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
}

CreateSecretRequest wrapper for the CreateSecret operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CreateSecret.go.html to see an example of how to use CreateSecretRequest.

func (CreateSecretRequest) HTTPRequest 

func (request CreateSecretRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSecretRequest) RetryPolicy 

func (request CreateSecretRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSecretRequest) String 

func (request CreateSecretRequest) String() string

type CreateSecretResponse 

type CreateSecretResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Secret instance
	Secret `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"`
}

CreateSecretResponse wrapper for the CreateSecret operation

func (CreateSecretResponse) HTTPResponse 

func (response CreateSecretResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSecretResponse) String 

func (response CreateSecretResponse) String() string

type GetSecretRequest 

type GetSecretRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// 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
}

GetSecretRequest wrapper for the GetSecret operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/GetSecret.go.html to see an example of how to use GetSecretRequest.

func (GetSecretRequest) HTTPRequest 

func (request GetSecretRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSecretRequest) RetryPolicy 

func (request GetSecretRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSecretRequest) String 

func (request GetSecretRequest) String() string

type GetSecretResponse 

type GetSecretResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Secret instance
	Secret `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"`
}

GetSecretResponse wrapper for the GetSecret operation

func (GetSecretResponse) HTTPResponse 

func (response GetSecretResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSecretResponse) String 

func (response GetSecretResponse) String() string

type GetSecretVersionRequest 

type GetSecretVersionRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// The version number of the secret.
	SecretVersionNumber *int64 `mandatory:"true" contributesTo:"path" name:"secretVersionNumber"`

	// 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
}

GetSecretVersionRequest wrapper for the GetSecretVersion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/GetSecretVersion.go.html to see an example of how to use GetSecretVersionRequest.

func (GetSecretVersionRequest) HTTPRequest 

func (request GetSecretVersionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSecretVersionRequest) RetryPolicy 

func (request GetSecretVersionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSecretVersionRequest) String 

func (request GetSecretVersionRequest) String() string

type GetSecretVersionResponse 

type GetSecretVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SecretVersion instance
	SecretVersion `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"`
}

GetSecretVersionResponse wrapper for the GetSecretVersion operation

func (GetSecretVersionResponse) HTTPResponse 

func (response GetSecretVersionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSecretVersionResponse) String 

func (response GetSecretVersionResponse) String() string

type ListSecretVersionsRequest 

type ListSecretVersionsRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// 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. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.
	SortBy ListSecretVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListSecretVersionsSortOrderEnum `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
}

ListSecretVersionsRequest wrapper for the ListSecretVersions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ListSecretVersions.go.html to see an example of how to use ListSecretVersionsRequest.

func (ListSecretVersionsRequest) HTTPRequest 

func (request ListSecretVersionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSecretVersionsRequest) RetryPolicy 

func (request ListSecretVersionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSecretVersionsRequest) String 

func (request ListSecretVersionsRequest) String() string

type ListSecretVersionsResponse 

type ListSecretVersionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []SecretVersionSummary instances
	Items []SecretVersionSummary `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"`
}

ListSecretVersionsResponse wrapper for the ListSecretVersions operation

func (ListSecretVersionsResponse) HTTPResponse 

func (response ListSecretVersionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSecretVersionsResponse) String 

func (response ListSecretVersionsResponse) String() string

type ListSecretVersionsSortByEnum 

type ListSecretVersionsSortByEnum string

ListSecretVersionsSortByEnum Enum with underlying type: string 

const (
	ListSecretVersionsSortByVersionNumber ListSecretVersionsSortByEnum = "VERSION_NUMBER"
)

Set of constants representing the allowable values for ListSecretVersionsSortByEnum

func GetListSecretVersionsSortByEnumValues 

func GetListSecretVersionsSortByEnumValues() []ListSecretVersionsSortByEnum

GetListSecretVersionsSortByEnumValues Enumerates the set of values for ListSecretVersionsSortByEnum

type ListSecretVersionsSortOrderEnum 

type ListSecretVersionsSortOrderEnum string

ListSecretVersionsSortOrderEnum Enum with underlying type: string 

const (
	ListSecretVersionsSortOrderAsc  ListSecretVersionsSortOrderEnum = "ASC"
	ListSecretVersionsSortOrderDesc ListSecretVersionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSecretVersionsSortOrderEnum

func GetListSecretVersionsSortOrderEnumValues 

func GetListSecretVersionsSortOrderEnumValues() []ListSecretVersionsSortOrderEnum

GetListSecretVersionsSortOrderEnumValues Enumerates the set of values for ListSecretVersionsSortOrderEnum

type ListSecretsRequest 

type ListSecretsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The secret name.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// 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 `NAME` is ascending.
	SortBy ListSecretsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListSecretsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The OCID of the vault.
	VaultId *string `mandatory:"false" contributesTo:"query" name:"vaultId"`

	// A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.
	LifecycleState SecretSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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
}

ListSecretsRequest wrapper for the ListSecrets operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ListSecrets.go.html to see an example of how to use ListSecretsRequest.

func (ListSecretsRequest) HTTPRequest 

func (request ListSecretsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSecretsRequest) RetryPolicy 

func (request ListSecretsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSecretsRequest) String 

func (request ListSecretsRequest) String() string

type ListSecretsResponse 

type ListSecretsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []SecretSummary instances
	Items []SecretSummary `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"`
}

ListSecretsResponse wrapper for the ListSecrets operation

func (ListSecretsResponse) HTTPResponse 

func (response ListSecretsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSecretsResponse) String 

func (response ListSecretsResponse) String() string

type ListSecretsSortByEnum 

type ListSecretsSortByEnum string

ListSecretsSortByEnum Enum with underlying type: string 

const (
	ListSecretsSortByTimecreated ListSecretsSortByEnum = "TIMECREATED"
	ListSecretsSortByName        ListSecretsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListSecretsSortByEnum

func GetListSecretsSortByEnumValues 

func GetListSecretsSortByEnumValues() []ListSecretsSortByEnum

GetListSecretsSortByEnumValues Enumerates the set of values for ListSecretsSortByEnum

type ListSecretsSortOrderEnum 

type ListSecretsSortOrderEnum string

ListSecretsSortOrderEnum Enum with underlying type: string 

const (
	ListSecretsSortOrderAsc  ListSecretsSortOrderEnum = "ASC"
	ListSecretsSortOrderDesc ListSecretsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSecretsSortOrderEnum

func GetListSecretsSortOrderEnumValues 

func GetListSecretsSortOrderEnumValues() []ListSecretsSortOrderEnum

GetListSecretsSortOrderEnumValues Enumerates the set of values for ListSecretsSortOrderEnum

type ScheduleSecretDeletionDetails 

type ScheduleSecretDeletionDetails struct {

	// An optional property indicating when to delete the secret version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}

ScheduleSecretDeletionDetails Details for scheduling the deletion of the specified secret.

func (ScheduleSecretDeletionDetails) String 

func (m ScheduleSecretDeletionDetails) String() string

type ScheduleSecretDeletionRequest 

type ScheduleSecretDeletionRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// Request to schedule the deletion of a secret.
	ScheduleSecretDeletionDetails `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
}

ScheduleSecretDeletionRequest wrapper for the ScheduleSecretDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ScheduleSecretDeletion.go.html to see an example of how to use ScheduleSecretDeletionRequest.

func (ScheduleSecretDeletionRequest) HTTPRequest 

func (request ScheduleSecretDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleSecretDeletionRequest) RetryPolicy 

func (request ScheduleSecretDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScheduleSecretDeletionRequest) String 

func (request ScheduleSecretDeletionRequest) String() string

type ScheduleSecretDeletionResponse 

type ScheduleSecretDeletionResponse 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"`
}

ScheduleSecretDeletionResponse wrapper for the ScheduleSecretDeletion operation

func (ScheduleSecretDeletionResponse) HTTPResponse 

func (response ScheduleSecretDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScheduleSecretDeletionResponse) String 

func (response ScheduleSecretDeletionResponse) String() string

type ScheduleSecretVersionDeletionDetails 

type ScheduleSecretVersionDeletionDetails struct {

	// An optional property indicating when to delete the secret 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"`
}

ScheduleSecretVersionDeletionDetails Schedules the deletion of the specified secret version.

func (ScheduleSecretVersionDeletionDetails) String 

func (m ScheduleSecretVersionDeletionDetails) String() string

type ScheduleSecretVersionDeletionRequest 

type ScheduleSecretVersionDeletionRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// The version number of the secret.
	SecretVersionNumber *int64 `mandatory:"true" contributesTo:"path" name:"secretVersionNumber"`

	// Request to delete a secret version.
	ScheduleSecretVersionDeletionDetails `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
}

ScheduleSecretVersionDeletionRequest wrapper for the ScheduleSecretVersionDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ScheduleSecretVersionDeletion.go.html to see an example of how to use ScheduleSecretVersionDeletionRequest.

func (ScheduleSecretVersionDeletionRequest) HTTPRequest 

func (request ScheduleSecretVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleSecretVersionDeletionRequest) RetryPolicy 

func (request ScheduleSecretVersionDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScheduleSecretVersionDeletionRequest) String 

func (request ScheduleSecretVersionDeletionRequest) String() string

type ScheduleSecretVersionDeletionResponse 

type ScheduleSecretVersionDeletionResponse 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"`
}

ScheduleSecretVersionDeletionResponse wrapper for the ScheduleSecretVersionDeletion operation

func (ScheduleSecretVersionDeletionResponse) HTTPResponse 

func (response ScheduleSecretVersionDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScheduleSecretVersionDeletionResponse) String 

func (response ScheduleSecretVersionDeletionResponse) String() string

type Secret 

type Secret struct {

	// The OCID of the compartment where you want to create the secret.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the secret.
	Id *string `mandatory:"true" json:"id"`

	// The current lifecycle state of the secret.
	LifecycleState SecretLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The user-friendly name of the secret. Avoid entering confidential information.
	SecretName *string `mandatory:"true" json:"secretName"`

	// A property indicating when the secret was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the vault where the secret exists.
	VaultId *string `mandatory:"true" json:"vaultId"`

	// The version number of the secret version that's currently in use.
	CurrentVersionNumber *int64 `mandatory:"false" json:"currentVersionNumber"`

	// 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 brief description of the secret. Avoid entering confidential information.
	Description *string `mandatory:"false" json:"description"`

	// 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 OCID of the master encryption key that is used to encrypt the secret.
	KeyId *string `mandatory:"false" json:"keyId"`

	// Additional information about the current lifecycle state of the secret.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// Additional metadata that you can use to provide context about how to use the secret or during rotation or
	// other administrative tasks. For example, for a secret that you use to connect to a database, the additional
	// metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.
	Metadata map[string]interface{} `mandatory:"false" json:"metadata"`

	// A list of rules that control how the secret is used and managed.
	SecretRules []SecretRule `mandatory:"false" json:"secretRules"`

	// An optional property indicating when the current secret version will expire, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeOfCurrentVersionExpiry *common.SDKTime `mandatory:"false" json:"timeOfCurrentVersionExpiry"`

	// An optional property indicating when to delete the secret, 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"`
}

Secret The details of the secret. Secret details do not contain the contents of the secret itself.

func (Secret) String 

func (m Secret) String() string

func (*Secret) UnmarshalJSON 

func (m *Secret) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type SecretContentDetails 

type SecretContentDetails interface {

	// Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
	GetName() *string

	// The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version
	// that you mark as `PENDING` is staged and available for use, but you don't yet want to rotate it into current, active use. For example,
	// you might create or update a secret and mark its rotation state as `PENDING` if you haven't yet updated the secret on the target system.
	// When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating
	// a secret, you can specify a version's rotation state as either `CURRENT` or `PENDING`.
	GetStage() SecretContentDetailsStageEnum
}

SecretContentDetails The content of the secret and metadata to help identify it.

type SecretContentDetailsContentTypeEnum 

type SecretContentDetailsContentTypeEnum string

SecretContentDetailsContentTypeEnum Enum with underlying type: string 

const (
	SecretContentDetailsContentTypeBase64 SecretContentDetailsContentTypeEnum = "BASE64"
)

Set of constants representing the allowable values for SecretContentDetailsContentTypeEnum

func GetSecretContentDetailsContentTypeEnumValues 

func GetSecretContentDetailsContentTypeEnumValues() []SecretContentDetailsContentTypeEnum

GetSecretContentDetailsContentTypeEnumValues Enumerates the set of values for SecretContentDetailsContentTypeEnum

type SecretContentDetailsStageEnum 

type SecretContentDetailsStageEnum string

SecretContentDetailsStageEnum Enum with underlying type: string 

const (
	SecretContentDetailsStageCurrent SecretContentDetailsStageEnum = "CURRENT"
	SecretContentDetailsStagePending SecretContentDetailsStageEnum = "PENDING"
)

Set of constants representing the allowable values for SecretContentDetailsStageEnum

func GetSecretContentDetailsStageEnumValues 

func GetSecretContentDetailsStageEnumValues() []SecretContentDetailsStageEnum

GetSecretContentDetailsStageEnumValues Enumerates the set of values for SecretContentDetailsStageEnum

type SecretExpiryRule 

type SecretExpiryRule struct {

	// A property indicating how long the secret contents will be considered valid, expressed in
	// ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format. The secret needs to be
	// updated when the secret content expires. No enforcement mechanism exists at this time, but audit logs
	// record the expiration on the appropriate date, according to the time interval specified in the rule.
	// The timer resets after you update the secret contents.
	// The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported.
	// For example, pass `P3D` to have the secret version expire every 3 days.
	SecretVersionExpiryInterval *string `mandatory:"false" json:"secretVersionExpiryInterval"`

	// An optional property indicating the absolute time when this secret will expire, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeOfAbsoluteExpiry *common.SDKTime `mandatory:"false" json:"timeOfAbsoluteExpiry"`

	// A property indicating whether to block retrieval of the secret content, on expiry. The default is false.
	// If the secret has already expired and you would like to retrieve the secret contents,
	// you need to edit the secret rule to disable this property, to allow reading the secret content.
	IsSecretContentRetrievalBlockedOnExpiry *bool `mandatory:"false" json:"isSecretContentRetrievalBlockedOnExpiry"`
}

SecretExpiryRule A rule that helps enforce the expiration of a secret's contents.

func (SecretExpiryRule) MarshalJSON 

func (m SecretExpiryRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SecretExpiryRule) String 

func (m SecretExpiryRule) String() string

type SecretLifecycleStateEnum 

type SecretLifecycleStateEnum string

SecretLifecycleStateEnum Enum with underlying type: string 

const (
	SecretLifecycleStateCreating           SecretLifecycleStateEnum = "CREATING"
	SecretLifecycleStateActive             SecretLifecycleStateEnum = "ACTIVE"
	SecretLifecycleStateUpdating           SecretLifecycleStateEnum = "UPDATING"
	SecretLifecycleStateDeleting           SecretLifecycleStateEnum = "DELETING"
	SecretLifecycleStateDeleted            SecretLifecycleStateEnum = "DELETED"
	SecretLifecycleStateSchedulingDeletion SecretLifecycleStateEnum = "SCHEDULING_DELETION"
	SecretLifecycleStatePendingDeletion    SecretLifecycleStateEnum = "PENDING_DELETION"
	SecretLifecycleStateCancellingDeletion SecretLifecycleStateEnum = "CANCELLING_DELETION"
	SecretLifecycleStateFailed             SecretLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for SecretLifecycleStateEnum

func GetSecretLifecycleStateEnumValues 

func GetSecretLifecycleStateEnumValues() []SecretLifecycleStateEnum

GetSecretLifecycleStateEnumValues Enumerates the set of values for SecretLifecycleStateEnum

type SecretReuseRule 

type SecretReuseRule struct {

	// A property indicating whether the rule is applied even if the secret version with the content you are trying to reuse was deleted.
	IsEnforcedOnDeletedSecretVersions *bool `mandatory:"false" json:"isEnforcedOnDeletedSecretVersions"`
}

SecretReuseRule A rule that disallows reuse of previously used secret content by the specified secret.

func (SecretReuseRule) MarshalJSON 

func (m SecretReuseRule) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SecretReuseRule) String 

func (m SecretReuseRule) String() string

type SecretRule 

type SecretRule interface {
}

SecretRule A rule that you can apply to a secret to enforce certain conditions on the secret's usage and management.

type SecretRuleRuleTypeEnum 

type SecretRuleRuleTypeEnum string

SecretRuleRuleTypeEnum Enum with underlying type: string 

const (
	SecretRuleRuleTypeExpiryRule SecretRuleRuleTypeEnum = "SECRET_EXPIRY_RULE"
	SecretRuleRuleTypeReuseRule  SecretRuleRuleTypeEnum = "SECRET_REUSE_RULE"
)

Set of constants representing the allowable values for SecretRuleRuleTypeEnum

func GetSecretRuleRuleTypeEnumValues 

func GetSecretRuleRuleTypeEnumValues() []SecretRuleRuleTypeEnum

GetSecretRuleRuleTypeEnumValues Enumerates the set of values for SecretRuleRuleTypeEnum

type SecretSummary 

type SecretSummary struct {

	// The OCID of the compartment that contains the secret.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the secret.
	Id *string `mandatory:"true" json:"id"`

	// The current lifecycle state of the secret.
	LifecycleState SecretSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The name of the secret.
	SecretName *string `mandatory:"true" json:"secretName"`

	// A property indicating when the secret was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the Vault in which the secret exists
	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"`

	// A brief description of the secret.
	Description *string `mandatory:"false" json:"description"`

	// 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 OCID of the master encryption key that is used to encrypt the secret.
	KeyId *string `mandatory:"false" json:"keyId"`

	// Additional information about the secret's current lifecycle state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// An optional property indicating when the current secret version will expire, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeOfCurrentVersionExpiry *common.SDKTime `mandatory:"false" json:"timeOfCurrentVersionExpiry"`

	// An optional property indicating when to delete the secret, 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"`
}

SecretSummary The details of the secret, excluding the contents of the secret.

func (SecretSummary) String 

func (m SecretSummary) String() string

type SecretSummaryLifecycleStateEnum 

type SecretSummaryLifecycleStateEnum string

SecretSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	SecretSummaryLifecycleStateCreating           SecretSummaryLifecycleStateEnum = "CREATING"
	SecretSummaryLifecycleStateActive             SecretSummaryLifecycleStateEnum = "ACTIVE"
	SecretSummaryLifecycleStateUpdating           SecretSummaryLifecycleStateEnum = "UPDATING"
	SecretSummaryLifecycleStateDeleting           SecretSummaryLifecycleStateEnum = "DELETING"
	SecretSummaryLifecycleStateDeleted            SecretSummaryLifecycleStateEnum = "DELETED"
	SecretSummaryLifecycleStateSchedulingDeletion SecretSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
	SecretSummaryLifecycleStatePendingDeletion    SecretSummaryLifecycleStateEnum = "PENDING_DELETION"
	SecretSummaryLifecycleStateCancellingDeletion SecretSummaryLifecycleStateEnum = "CANCELLING_DELETION"
	SecretSummaryLifecycleStateFailed             SecretSummaryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for SecretSummaryLifecycleStateEnum

func GetSecretSummaryLifecycleStateEnumValues 

func GetSecretSummaryLifecycleStateEnumValues() []SecretSummaryLifecycleStateEnum

GetSecretSummaryLifecycleStateEnumValues Enumerates the set of values for SecretSummaryLifecycleStateEnum

type SecretVersion 

type SecretVersion struct {

	// The content type of the secret version's secret contents.
	ContentType SecretVersionContentTypeEnum `mandatory:"false" json:"contentType,omitempty"`

	// The name of the secret version. A name is unique across versions of a secret.
	Name *string `mandatory:"false" json:"name"`

	// The OCID of the secret.
	SecretId *string `mandatory:"false" json:"secretId"`

	// A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version
	// marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated
	// into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is
	// always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked
	// `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous
	// one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion.
	Stages []SecretVersionStagesEnum `mandatory:"false" json:"stages,omitempty"`

	// A optional property indicating when the secret version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// An optional property indicating when to delete the secret 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"`

	// An optional property indicating when the current secret version will expire, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeOfCurrentVersionExpiry *common.SDKTime `mandatory:"false" json:"timeOfCurrentVersionExpiry"`

	// The version number of the secret.
	VersionNumber *int64 `mandatory:"false" json:"versionNumber"`
}

SecretVersion The details of the secret version, excluding the contents of the secret.

func (SecretVersion) String 

func (m SecretVersion) String() string

type SecretVersionContentTypeEnum 

type SecretVersionContentTypeEnum string

SecretVersionContentTypeEnum Enum with underlying type: string 

const (
	SecretVersionContentTypeBase64 SecretVersionContentTypeEnum = "BASE64"
)

Set of constants representing the allowable values for SecretVersionContentTypeEnum

func GetSecretVersionContentTypeEnumValues 

func GetSecretVersionContentTypeEnumValues() []SecretVersionContentTypeEnum

GetSecretVersionContentTypeEnumValues Enumerates the set of values for SecretVersionContentTypeEnum

type SecretVersionStagesEnum 

type SecretVersionStagesEnum string

SecretVersionStagesEnum Enum with underlying type: string 

const (
	SecretVersionStagesCurrent    SecretVersionStagesEnum = "CURRENT"
	SecretVersionStagesPending    SecretVersionStagesEnum = "PENDING"
	SecretVersionStagesLatest     SecretVersionStagesEnum = "LATEST"
	SecretVersionStagesPrevious   SecretVersionStagesEnum = "PREVIOUS"
	SecretVersionStagesDeprecated SecretVersionStagesEnum = "DEPRECATED"
)

Set of constants representing the allowable values for SecretVersionStagesEnum

func GetSecretVersionStagesEnumValues 

func GetSecretVersionStagesEnumValues() []SecretVersionStagesEnum

GetSecretVersionStagesEnumValues Enumerates the set of values for SecretVersionStagesEnum

type SecretVersionSummary 

type SecretVersionSummary struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" json:"secretId"`

	// A optional property indicating when the secret version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The version number of the secret.
	VersionNumber *int64 `mandatory:"true" json:"versionNumber"`

	// The content type of the secret version's secret contents.
	ContentType SecretVersionSummaryContentTypeEnum `mandatory:"false" json:"contentType,omitempty"`

	// The name of the secret version. A name is unique across versions of a secret.
	Name *string `mandatory:"false" json:"name"`

	// A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version
	// marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated
	// into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is
	// always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked
	// `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous
	// one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion.
	Stages []SecretVersionSummaryStagesEnum `mandatory:"false" json:"stages,omitempty"`

	// An optional property indicating when to delete the secret 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"`

	// An optional property indicating when the secret version will expire, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
	// Example: `2019-04-03T21:10:29.600Z`
	TimeOfExpiry *common.SDKTime `mandatory:"false" json:"timeOfExpiry"`
}

SecretVersionSummary The secret version summary object, which doesn't include the contents of the secret.

func (SecretVersionSummary) String 

func (m SecretVersionSummary) String() string

type SecretVersionSummaryContentTypeEnum 

type SecretVersionSummaryContentTypeEnum string

SecretVersionSummaryContentTypeEnum Enum with underlying type: string 

const (
	SecretVersionSummaryContentTypeBase64 SecretVersionSummaryContentTypeEnum = "BASE64"
)

Set of constants representing the allowable values for SecretVersionSummaryContentTypeEnum

func GetSecretVersionSummaryContentTypeEnumValues 

func GetSecretVersionSummaryContentTypeEnumValues() []SecretVersionSummaryContentTypeEnum

GetSecretVersionSummaryContentTypeEnumValues Enumerates the set of values for SecretVersionSummaryContentTypeEnum

type SecretVersionSummaryStagesEnum 

type SecretVersionSummaryStagesEnum string

SecretVersionSummaryStagesEnum Enum with underlying type: string 

const (
	SecretVersionSummaryStagesCurrent    SecretVersionSummaryStagesEnum = "CURRENT"
	SecretVersionSummaryStagesPending    SecretVersionSummaryStagesEnum = "PENDING"
	SecretVersionSummaryStagesLatest     SecretVersionSummaryStagesEnum = "LATEST"
	SecretVersionSummaryStagesPrevious   SecretVersionSummaryStagesEnum = "PREVIOUS"
	SecretVersionSummaryStagesDeprecated SecretVersionSummaryStagesEnum = "DEPRECATED"
)

Set of constants representing the allowable values for SecretVersionSummaryStagesEnum

func GetSecretVersionSummaryStagesEnumValues 

func GetSecretVersionSummaryStagesEnumValues() []SecretVersionSummaryStagesEnum

GetSecretVersionSummaryStagesEnumValues Enumerates the set of values for SecretVersionSummaryStagesEnum

type UpdateSecretDetails 

type UpdateSecretDetails struct {

	// Details to update the secret version of the specified secret. The secret contents,
	// version number, and rules can't be specified at the same time.
	// Updating the secret contents automatically creates a new secret version.
	CurrentVersionNumber *int64 `mandatory:"false" json:"currentVersionNumber"`

	// 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 brief description of the secret. Avoid entering confidential information.
	Description *string `mandatory:"false" json:"description"`

	// 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"`

	// Additional metadata that you can use to provide context about how to use the secret or during rotation or
	// other administrative tasks. For example, for a secret that you use to connect to a database, the additional
	// metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.
	Metadata map[string]interface{} `mandatory:"false" json:"metadata"`

	SecretContent SecretContentDetails `mandatory:"false" json:"secretContent"`

	// A list of rules to control how the secret is used and managed.
	SecretRules []SecretRule `mandatory:"false" json:"secretRules"`
}

UpdateSecretDetails Details for updating a secret.

func (UpdateSecretDetails) String 

func (m UpdateSecretDetails) String() string

func (*UpdateSecretDetails) UnmarshalJSON 

func (m *UpdateSecretDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type UpdateSecretRequest 

type UpdateSecretRequest struct {

	// The OCID of the secret.
	SecretId *string `mandatory:"true" contributesTo:"path" name:"secretId"`

	// Request to update a secret.
	UpdateSecretDetails `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
}

UpdateSecretRequest wrapper for the UpdateSecret operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/UpdateSecret.go.html to see an example of how to use UpdateSecretRequest.

func (UpdateSecretRequest) HTTPRequest 

func (request UpdateSecretRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSecretRequest) RetryPolicy 

func (request UpdateSecretRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSecretRequest) String 

func (request UpdateSecretRequest) String() string

type UpdateSecretResponse 

type UpdateSecretResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Secret instance
	Secret `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"`
}

UpdateSecretResponse wrapper for the UpdateSecret operation

func (UpdateSecretResponse) HTTPResponse 

func (response UpdateSecretResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSecretResponse) String 

func (response UpdateSecretResponse) String() string

type VaultsClient 

type VaultsClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

VaultsClient a client for Vaults

func NewVaultsClientWithConfigurationProvider 

func NewVaultsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VaultsClient, err error)

NewVaultsClientWithConfigurationProvider Creates a new default Vaults client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewVaultsClientWithOboToken 

func NewVaultsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client VaultsClient, err error)

NewVaultsClientWithOboToken Creates a new default Vaults 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 (VaultsClient) CancelSecretDeletion 

func (client VaultsClient) CancelSecretDeletion(ctx context.Context, request CancelSecretDeletionRequest) (response CancelSecretDeletionResponse, err error)

CancelSecretDeletion Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret's lifecycle state to what it was before you scheduled the secret for deletion.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CancelSecretDeletion.go.html to see an example of how to use CancelSecretDeletion API.

func (VaultsClient) CancelSecretVersionDeletion 

func (client VaultsClient) CancelSecretVersionDeletion(ctx context.Context, request CancelSecretVersionDeletionRequest) (response CancelSecretVersionDeletionResponse, err error)

CancelSecretVersionDeletion Cancels the scheduled deletion of a secret version.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CancelSecretVersionDeletion.go.html to see an example of how to use CancelSecretVersionDeletion API.

func (VaultsClient) ChangeSecretCompartment 

func (client VaultsClient) ChangeSecretCompartment(ctx context.Context, request ChangeSecretCompartmentRequest) (response ChangeSecretCompartmentResponse, err error)

ChangeSecretCompartment Moves a secret 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 secret.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ChangeSecretCompartment.go.html to see an example of how to use ChangeSecretCompartment API.

func (*VaultsClient) ConfigurationProvider 

func (client *VaultsClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (VaultsClient) CreateSecret 

func (client VaultsClient) CreateSecret(ctx context.Context, request CreateSecretRequest) (response CreateSecretResponse, err error)

CreateSecret Creates a new secret according to the details of the request. This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/CreateSecret.go.html to see an example of how to use CreateSecret API.

func (VaultsClient) GetSecret 

func (client VaultsClient) GetSecret(ctx context.Context, request GetSecretRequest) (response GetSecretResponse, err error)

GetSecret Gets information about the specified secret.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/GetSecret.go.html to see an example of how to use GetSecret API.

func (VaultsClient) GetSecretVersion 

func (client VaultsClient) GetSecretVersion(ctx context.Context, request GetSecretVersionRequest) (response GetSecretVersionResponse, err error)

GetSecretVersion Gets information about the specified version of a secret.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/GetSecretVersion.go.html to see an example of how to use GetSecretVersion API.

func (VaultsClient) ListSecretVersions 

func (client VaultsClient) ListSecretVersions(ctx context.Context, request ListSecretVersionsRequest) (response ListSecretVersionsResponse, err error)

ListSecretVersions Lists all secret versions for the specified secret.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ListSecretVersions.go.html to see an example of how to use ListSecretVersions API.

func (VaultsClient) ListSecrets 

func (client VaultsClient) ListSecrets(ctx context.Context, request ListSecretsRequest) (response ListSecretsResponse, err error)

ListSecrets Lists all secrets in the specified vault and compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ListSecrets.go.html to see an example of how to use ListSecrets API.

func (VaultsClient) ScheduleSecretDeletion 

func (client VaultsClient) ScheduleSecretDeletion(ctx context.Context, request ScheduleSecretDeletionRequest) (response ScheduleSecretDeletionResponse, err error)

ScheduleSecretDeletion Schedules the deletion of the specified secret. This sets the lifecycle state of the secret to `PENDING_DELETION` and then deletes it after the specified retention period ends.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ScheduleSecretDeletion.go.html to see an example of how to use ScheduleSecretDeletion API.

func (VaultsClient) ScheduleSecretVersionDeletion 

func (client VaultsClient) ScheduleSecretVersionDeletion(ctx context.Context, request ScheduleSecretVersionDeletionRequest) (response ScheduleSecretVersionDeletionResponse, err error)

ScheduleSecretVersionDeletion Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as `DEPRECATED`.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/ScheduleSecretVersionDeletion.go.html to see an example of how to use ScheduleSecretVersionDeletion API.

func (*VaultsClient) SetRegion 

func (client *VaultsClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (VaultsClient) UpdateSecret 

func (client VaultsClient) UpdateSecret(ctx context.Context, request UpdateSecretRequest) (response UpdateSecretResponse, err error)

UpdateSecret Updates the properties of a secret. Specifically, you can update the version number of the secret to make that version number the current version. You can also update a secret's description, its free-form or defined tags, rules and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number and the secret contents and the rules at the same time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated. This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vault/UpdateSecret.go.html to see an example of how to use UpdateSecret API.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.