credentials

Documentation

Overview

CredHub credential types

Index

• type Base
• type BulkRegenerateResults
• type Certificate
• type Credential
  • func (c Credential) MarshalJSON() ([]byte, error)
  • func (c Credential) MarshalYAML() (interface{}, error)
• type FindResults
• type JSON
• type Metadata
• type Password
• type Path
• type Paths
• type RSA
• type SSH
• type User
• type Value

Types

type Base

type Base struct {
	Name             string `json:"name" yaml:"name"`
	VersionCreatedAt string `json:"version_created_at" yaml:"version_created_at"`
}

Base fields of a credential

type BulkRegenerateResults

type BulkRegenerateResults struct {
	Certificates []string `json:"regenerated_credentials" yaml:"regenerated_credentials"`
}

Type needed for Bulk Regenerate functionality

type Certificate

type Certificate struct {
	Metadata `yaml:",inline"`
	Value    values.Certificate `json:"value"`
}

A Certificate type credential

type Credential

type Credential struct {
	Metadata `yaml:",inline"`
	Value    interface{} `json:"value"`
}

A generic credential

Used when the Type of the credential is not known ahead of time.

Value will be as unmarshalled by https://golang.org/pkg/encoding/json/#Unmarshal

func (Credential) MarshalJSON

func (c Credential) MarshalJSON() ([]byte, error)

func (Credential) MarshalYAML

func (c Credential) MarshalYAML() (interface{}, error)

type FindResults

type FindResults struct {
	Credentials []Base `json:"credentials" yaml:"credentials"`
}

Types needed for Find functionality

type JSON

type JSON struct {
	Metadata `yaml:",inline"`
	Value    values.JSON `json:"value"`
}

A JSON type credential

type Metadata

type Metadata struct {
	Id   string `json:"id"`
	Base `yaml:",inline"`
	Type string `json:"type"`
}

type Password

type Password struct {
	Metadata `yaml:",inline"`
	Value    values.Password `json:"value"`
}

A Password type credential

type Path

type Path struct {
	Path string `json:"path" yaml:"path"`
}

type Paths

type Paths struct {
	Paths []Path `json:"paths" yaml:"paths"`
}

type RSA

type RSA struct {
	Metadata `yaml:",inline"`
	Value    values.RSA `json:"value"`
}

An RSA type credential

type SSH

type SSH struct {
	Metadata `yaml:",inline"`
	Value    struct {
		values.SSH           `yaml:",inline"`
		PublicKeyFingerprint string `json:"public_key_fingerprint" yaml:"public_key_fingerprint"`
	} `json:"value"`
}

An SSH type credential

type User

type User struct {
	Metadata `yaml:",inline"`
	Value    struct {
		values.User  `yaml:",inline"`
		PasswordHash string `json:"password_hash" yaml:"password_hash"`
	} `json:"value"`
}

A User type credential

type Value

type Value struct {
	Metadata `yaml:",inline"`
	Value    values.Value `json:"value"`
}

A Value type credential