key

Documentation

Index

• Constants
• type GetKeysResponse
• type KeyReporting
• type KeyRequest
• type PathConfig
• type RequestKey
  • func (rk *RequestKey) Validate() error
• type ResponseKey
  • func (rk *ResponseKey) GetSettingIds() []string
• type TimeUnit
• type UpdateKey
  • func (uk *UpdateKey) Validate() error

Constants

const RevokedReasonExpired string = "expired"

Types

type GetKeysResponse

type GetKeysResponse struct {
	Keys  []*ResponseKey `json:"keys"`
	Count int            `json:"count"`
}

type KeyReporting

type KeyReporting struct {
	Id                 string `json:"id"`
	CostInMicroDollars int64  `json:"costInMicroDollars"`
}

type KeyRequest

type KeyRequest struct {
	KeyIds      []string `json:"keyIds"`
	Tags        []string `json:"tags"`
	Name        string   `json:"name"`
	Revoked     *bool    `json:"revoked"`
	Limit       int      `json:"limit"`
	Offset      int      `json:"offset"`
	Order       string   `json:"order"`
	ReturnCount bool     `json:"returnCount"`
}

type PathConfig

type PathConfig struct {
	Method string `json:"method"`
	Path   string `json:"path"`
}

type RequestKey

type RequestKey struct {
	Name                   string       `json:"name"`
	CreatedAt              int64        `json:"createdAt"`
	UpdatedAt              int64        `json:"updatedAt"`
	Tags                   []string     `json:"tags"`
	KeyId                  string       `json:"keyId"`
	Key                    string       `json:"key"`
	CostLimitInUsd         float64      `json:"costLimitInUsd"`
	CostLimitInUsdOverTime float64      `json:"costLimitInUsdOverTime"`
	CostLimitInUsdUnit     TimeUnit     `json:"costLimitInUsdUnit"`
	RateLimitOverTime      int          `json:"rateLimitOverTime"`
	RateLimitUnit          TimeUnit     `json:"rateLimitUnit"`
	Ttl                    string       `json:"ttl"`
	SettingId              string       `json:"settingId"`
	AllowedPaths           []PathConfig `json:"allowedPaths"`
	SettingIds             []string     `json:"settingIds"`
	ShouldLogRequest       bool         `json:"shouldLogRequest"`
	ShouldLogResponse      bool         `json:"shouldLogResponse"`
	RotationEnabled        bool         `json:"rotationEnabled"`
	PolicyId               string       `json:"policyId"`
	IsKeyNotHashed         bool         `json:"isKeyNotHashed"`
}

func (*RequestKey) Validate

func (rk *RequestKey) Validate() error

type ResponseKey

type ResponseKey struct {
	Name                   string       `json:"name"`
	CreatedAt              int64        `json:"createdAt"`
	UpdatedAt              int64        `json:"updatedAt"`
	Tags                   []string     `json:"tags"`
	KeyId                  string       `json:"keyId"`
	Revoked                bool         `json:"revoked"`
	Key                    string       `json:"key"`
	RevokedReason          string       `json:"revokedReason"`
	CostLimitInUsd         float64      `json:"costLimitInUsd"`
	CostLimitInUsdOverTime float64      `json:"costLimitInUsdOverTime"`
	CostLimitInUsdUnit     TimeUnit     `json:"costLimitInUsdUnit"`
	RateLimitOverTime      int          `json:"rateLimitOverTime"`
	RateLimitUnit          TimeUnit     `json:"rateLimitUnit"`
	Ttl                    string       `json:"ttl"`
	SettingId              string       `json:"settingId"`
	AllowedPaths           []PathConfig `json:"allowedPaths"`
	SettingIds             []string     `json:"settingIds"`
	ShouldLogRequest       bool         `json:"shouldLogRequest"`
	ShouldLogResponse      bool         `json:"shouldLogResponse"`
	RotationEnabled        bool         `json:"rotationEnabled"`
	PolicyId               string       `json:"policyId"`
	IsKeyNotHashed         bool         `json:"isKeyNotHashed"`
}

func (*ResponseKey) GetSettingIds

func (rk *ResponseKey) GetSettingIds() []string

type TimeUnit

type TimeUnit string

const (
	HourTimeUnit   TimeUnit = "h"
	MinuteTimeUnit TimeUnit = "m"
	SecondTimeUnit TimeUnit = "s"
	DayTimeUnit    TimeUnit = "d"
	MonthTimeUnit  TimeUnit = "mo"
)

type UpdateKey

type UpdateKey struct {
	Name                   string        `json:"name"`
	UpdatedAt              int64         `json:"updatedAt"`
	Tags                   []string      `json:"tags"`
	Revoked                *bool         `json:"revoked"`
	RevokedReason          string        `json:"revokedReason"`
	Key                    string        `json:"key"`
	SettingId              string        `json:"settingId"`
	SettingIds             []string      `json:"settingIds"`
	CostLimitInUsd         *float64      `json:"costLimitInUsd"`
	CostLimitInUsdOverTime *float64      `json:"costLimitInUsdOverTime"`
	CostLimitInUsdUnit     *TimeUnit     `json:"costLimitInUsdUnit"`
	RateLimitOverTime      *int          `json:"rateLimitOverTime"`
	RateLimitUnit          *TimeUnit     `json:"rateLimitUnit"`
	AllowedPaths           *[]PathConfig `json:"allowedPaths,omitempty"`
	ShouldLogRequest       *bool         `json:"shouldLogRequest"`
	ShouldLogResponse      *bool         `json:"shouldLogResponse"`
	RotationEnabled        *bool         `json:"rotationEnabled"`
	PolicyId               *string       `json:"policyId"`
	IsKeyNotHashed         *bool         `json:"isKeyNotHashed"`
}

func (*UpdateKey) Validate

func (uk *UpdateKey) Validate() error