vault

Documentation

Index

• Variables
• type CertificateFormat
  • func (me CertificateFormat) Ref() *CertificateFormat
• type CredentialUsageObj
  • func (me *CredentialUsageObj) MarshalHCL(properties hcl.Properties) error
  • func (me *CredentialUsageObj) Schema() map[string]*schema.Schema
  • func (me *CredentialUsageObj) UnmarshalHCL(decoder hcl.Decoder) error
• type Credentials
  • func (me *Credentials) EnsurePredictableOrder()
  • func (me *Credentials) FillDemoValues() []string
  • func (me *Credentials) MarshalHCL(properties hcl.Properties) error
  • func (me *Credentials) Schema() map[string]*schema.Schema
  • func (me *Credentials) UnmarshalHCL(decoder hcl.Decoder) error
• type CredentialsList
  • func (me CredentialsList) ToStubs() api.Stubs
• type CredentialsResponseElement
• type CredentialsResponseElementType
• type CredentialsType
• type ExternalVaultConfigType
• type MonitorType
• type Scope
• type UsageSummary

Variables

var CertificateFormats = struct {
	Pem     CertificateFormat
	Pkcs12  CertificateFormat
	Unknown CertificateFormat
}{
	"PEM",
	"PKCS12",
	"UNKNOWN",
}

CertificateFormats offers the known enum values

var CredentialsResponseElementTypes = struct {
	Certificate       CredentialsResponseElementType
	PublicCertificate CredentialsResponseElementType
	Token             CredentialsResponseElementType
	Unknown           CredentialsResponseElementType
	UsernamePassword  CredentialsResponseElementType
}{
	CredentialsResponseElementType("CERTIFICATE"),
	CredentialsResponseElementType("PUBLIC_CERTIFICATE"),
	CredentialsResponseElementType("TOKEN"),
	CredentialsResponseElementType("UNKNOWN"),
	CredentialsResponseElementType("USERNAME_PASSWORD"),
}

CredentialsResponseElementTypes offers the known enum values

var CredentialsTypes = struct {
	Certificate       CredentialsType
	PublicCertificate CredentialsType
	Token             CredentialsType
	UsernamePassword  CredentialsType
	Unknown           CredentialsType
}{
	"CERTIFICATE",
	"PUBLIC_CERTIFICATE",
	"TOKEN",
	"USERNAME_PASSWORD",
	"UNKNOWN",
}

var ExternalVaultConfigTypes = struct {
	AzureCertificateModel    ExternalVaultConfigType
	AzureClientSecretModel   ExternalVaultConfigType
	HashcorpAppRoleModel     ExternalVaultConfigType
	HashcorpCertificateModel ExternalVaultConfigType
}{
	ExternalVaultConfigType("AZURE_CERTIFICATE_MODEL"),
	ExternalVaultConfigType("AZURE_CLIENT_SECRET_MODEL"),
	ExternalVaultConfigType("HASHICORP_APPROLE_MODEL"),
	ExternalVaultConfigType("HASHICORP_CERTIFICATE_MODEL"),
}

var MonitorTypes = struct {
	HTTPMonitor     MonitorType
	BrowserMonitorl MonitorType
}{
	MonitorType("HTTP_MONITOR"),
	MonitorType("BROWSER_MONITOR"),
}

var Scopes = struct {
	All       Scope
	Extension Scope
	Synthetic Scope
	AppEngine Scope
	Unknown   Scope
}{
	Scope("ALL"),
	Scope("EXTENSION"),
	Scope("SYNTHETIC"),
	Scope("APP_ENGINE"),
	Scope("UNKNOWN"),
}

Types

type CertificateFormat

type CertificateFormat string

CertificateFormat The certificate format.

func (CertificateFormat) Ref

func (me CertificateFormat) Ref() *CertificateFormat

type CredentialUsageObj

type CredentialUsageObj struct {
	MonitorType MonitorType `json:"type"`
	Count       int32       `json:"count"`
}

func (*CredentialUsageObj) MarshalHCL

func (me *CredentialUsageObj) MarshalHCL(properties hcl.Properties) error

func (*CredentialUsageObj) Schema

func (me *CredentialUsageObj) Schema() map[string]*schema.Schema

func (*CredentialUsageObj) UnmarshalHCL

func (me *CredentialUsageObj) UnmarshalHCL(decoder hcl.Decoder) error

type Credentials

type Credentials struct {
	Name                     string                `json:"name"`                               // The name of the credentials set.
	Description              *string               `json:"description,omitempty"`              // A short description of the credentials set..
	OwnerAccessOnly          bool                  `json:"ownerAccessOnly"`                    // The credentials set is available to every user (`false`) or to owner only (`true`).
	Scope                    Scope                 `json:"scope,omitempty"`                    // Deprecated(v279), please use `scopes` instead. The scope of the credentials set
	Scopes                   []Scope               `json:"scopes,omitempty"`                   // The set of scopes of the credentials set.
	Type                     CredentialsType       `json:"type"`                               // Defines the actual set of fields depending on the value. See one of the following objects: \n\n* `CERTIFICATE` -> CertificateCredentials \n* `PUBLIC_CERTIFICATE` -> PublicCertificateCredentials \n* `USERNAME_PASSWORD` -> UserPasswordCredentials \n* `TOKEN` -> TokenCredentials \n
	Token                    *string               `json:"token,omitempty"`                    // Token in the string format.
	Password                 *string               `json:"password,omitempty"`                 // The password of the credential (Base64 encoded).
	Username                 *string               `json:"user,omitempty"`                     // The username of the credentials set.
	Certificate              *string               `json:"certificate,omitempty"`              // The certificate in the string (Base64) format.
	CertificateFormat        *CertificateFormat    `json:"certificateFormat,omitempty"`        // The certificate format.
	ExternalVault            *externalvault.Config `json:"externalVault,omitempty"`            // Configuration for external vault synchronization
	CredentialUsageSummary   UsageSummary          `json:"credentialUsageSummary,omitempty"`   // The list contains summary data related to the use of credentials
	AllowContextlessRequests *bool                 `json:"allowContextlessRequests,omitempty"` // Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).
}

func (*Credentials) EnsurePredictableOrder

func (me *Credentials) EnsurePredictableOrder()

func (*Credentials) FillDemoValues

func (me *Credentials) FillDemoValues() []string

func (*Credentials) MarshalHCL

func (me *Credentials) MarshalHCL(properties hcl.Properties) error

func (*Credentials) Schema

func (me *Credentials) Schema() map[string]*schema.Schema

func (*Credentials) UnmarshalHCL

func (me *Credentials) UnmarshalHCL(decoder hcl.Decoder) error

type CredentialsList

type CredentialsList struct {
	Credentials []CredentialsResponseElement `json:"credentials"` // A list of credentials sets for Synthetic monitors.
}

CredentialsList A list of credentials sets for Synthetic monitors.

func (CredentialsList) ToStubs

func (me CredentialsList) ToStubs() api.Stubs

type CredentialsResponseElement

type CredentialsResponseElement struct {
	Name            string                         `json:"name"`            // The name of the credentials set.
	ID              *string                        `json:"id,omitempty"`    // The ID of the credentials set.
	Description     string                         `json:"description"`     // A short description of the credentials set.
	Owner           string                         `json:"owner"`           // The owner of the credential.
	OwnerAccessOnly bool                           `json:"ownerAccessOnly"` // Flag indicating that this credential is visible only to the owner.
	Type            CredentialsResponseElementType `json:"type"`            // The type of the credentials set.
	Scope           Scope                          `json:"scope,omitempty"` // The scope of the credentials set
}

CredentialsResponseElement Metadata of the credentials set.

type CredentialsResponseElementType

type CredentialsResponseElementType string

CredentialsResponseElementType The type of the credentials set.

type CredentialsType

type CredentialsType string

type ExternalVaultConfigType

type ExternalVaultConfigType string

type MonitorType

type MonitorType string

type Scope

type Scope string

type UsageSummary

type UsageSummary []*CredentialUsageObj