models

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Jul 2, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey 

type APIKey struct {

	// list of useDomains that APIKey has access to
	AuthorizedUseDomains []string `json:"authorizedUseDomains"`

	// creation time
	CreationTime int64 `json:"creationTime,omitempty"`

	// creator
	Creator *Contact `json:"creator,omitempty"`

	// key
	// Required: true
	Key *string `json:"key"`

	// org Id
	// Required: true
	OrgID *string `json:"orgId"`
}

APIKey API key swagger:model APIKey

func (*APIKey) MarshalBinary 

func (m *APIKey) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIKey) UnmarshalBinary 

func (m *APIKey) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIKey) Validate 

func (m *APIKey) Validate(formats strfmt.Registry) error

Validate validates this API key

type AddOrganizationParameters added in v0.1.1 

type AddOrganizationParameters struct {

	// contact
	// Required: true
	Contact *Contact `json:"contact"`

	// manual params
	ManualParams []*ManualAuthNParameters `json:"manualParams"`

	// oidc params
	OidcParams []*OIDCAuthNParameters `json:"oidcParams"`
}

AddOrganizationParameters add organization parameters swagger:model AddOrganizationParameters

func (*AddOrganizationParameters) MarshalBinary added in v0.1.1 

func (m *AddOrganizationParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddOrganizationParameters) UnmarshalBinary added in v0.1.1 

func (m *AddOrganizationParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddOrganizationParameters) Validate added in v0.1.1 

func (m *AddOrganizationParameters) Validate(formats strfmt.Registry) error

Validate validates this add organization parameters

type Client 

type Client struct {

	// id
	// Required: true
	ID *string `json:"id"`

	// of all the public keys KeyDeriver's should deliver to this public key - it is also the most recently added public key
	PreferredPublicKeyID string `json:"preferredPublicKeyId,omitempty"`

	// public keys
	// Required: true
	PublicKeys []*PublicKey `json:"publicKeys"`

	// sdk
	Sdk string `json:"sdk,omitempty"`
}

Client client swagger:model Client

func (*Client) MarshalBinary 

func (m *Client) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Client) UnmarshalBinary 

func (m *Client) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Client) Validate 

func (m *Client) Validate(formats strfmt.Registry) error

Validate validates this client

type Contact 

type Contact struct {

	// email
	// Required: true
	Email *string `json:"email"`

	// name
	// Required: true
	Name *string `json:"name"`

	// phone
	Phone string `json:"phone,omitempty"`
}

Contact contact swagger:model Contact

func (*Contact) MarshalBinary 

func (m *Contact) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Contact) UnmarshalBinary 

func (m *Contact) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Contact) Validate 

func (m *Contact) Validate(formats strfmt.Registry) error

Validate validates this contact

type CryptoConfig 

type CryptoConfig struct {

	// the bit length of all new client keys, for example, 2048
	// Required: true
	ClientKeyBitlength *int64 `json:"clientKeyBitlength"`

	// the TTL on the client's local asymetric key
	// Required: true
	ClientKeyTTL *int64 `json:"clientKeyTTL"`

	// the type of key that should be associated with clients, for example, rsa
	// Required: true
	ClientKeyType *string `json:"clientKeyType"`

	// id
	// Required: true
	ID *string `json:"id"`

	// the org id of the organization that owns these symmetric keys
	// Required: true
	OwnerOrgID *string `json:"ownerOrgId"`

	// to guide SDK's on how to select an encryption domain, a selectorScheme helps an SDK map a encryption request to a set of keys and encryption algoritm
	// Required: true
	SymmetricKeyUseDomainSelectorScheme *string `json:"symmetricKeyUseDomainSelectorScheme"`

	// every application layer encryption must select a key to use from one specific active semmetric key encryption domain. this is an array of encryption domains id's that are currently available for encryption
	// Required: true
	SymmetricKeyUseDomains []*SymmetricKeyUseDomain `json:"symmetricKeyUseDomains"`
}

CryptoConfig crypto config swagger:model CryptoConfig

func (*CryptoConfig) MarshalBinary 

func (m *CryptoConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CryptoConfig) UnmarshalBinary 

func (m *CryptoConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CryptoConfig) Validate 

func (m *CryptoConfig) Validate(formats strfmt.Registry) error

Validate validates this crypto config

type EncryptedSymmetricKey 

type EncryptedSymmetricKey struct {

	// id's of the symmetric keys encrypted in packedCiphertext
	// Required: true
	KeyIds []string `json:"keyIds"`

	// length of the keys encrypted in packedCiphertext
	// Required: true
	KeyLength *int64 `json:"keyLength"`

	// the actual packaged ciphertext of the encrypted symmetric key, of key
	// Required: true
	PackagedCiphertext *string `json:"packagedCiphertext"`

	// id of the symmetric key use domain which contains this key
	// Required: true
	SymmetricKeyUseDomainID *string `json:"symmetricKeyUseDomainId"`
}

EncryptedSymmetricKey encrypted symmetric key swagger:model EncryptedSymmetricKey

func (*EncryptedSymmetricKey) MarshalBinary 

func (m *EncryptedSymmetricKey) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EncryptedSymmetricKey) UnmarshalBinary 

func (m *EncryptedSymmetricKey) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EncryptedSymmetricKey) Validate 

func (m *EncryptedSymmetricKey) Validate(formats strfmt.Registry) error

Validate validates this encrypted symmetric key

type ErrorResponse 

type ErrorResponse struct {

	// msg
	// Required: true
	Msg *string `json:"msg"`
}

ErrorResponse error response swagger:model ErrorResponse

func (*ErrorResponse) MarshalBinary 

func (m *ErrorResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorResponse) UnmarshalBinary 

func (m *ErrorResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorResponse) Validate 

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type HeatbeatResponse 

type HeatbeatResponse struct {

	// an array of symmetri key requests for this ker deriver instance
	// Required: true
	Requests []*SymmetricKeyRequest `json:"requests"`
}

HeatbeatResponse heatbeat response swagger:model HeatbeatResponse

func (*HeatbeatResponse) MarshalBinary 

func (m *HeatbeatResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*HeatbeatResponse) UnmarshalBinary 

func (m *HeatbeatResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*HeatbeatResponse) Validate 

func (m *HeatbeatResponse) Validate(formats strfmt.Registry) error

Validate validates this heatbeat response

type KeyDerivationInstance 

type KeyDerivationInstance struct {

	// currently online and accepting requests for key derivation
	// Required: true
	Active *bool `json:"active"`

	// base URL from which this key deriver instance will respond to new key derivation job requests
	BaseURL string `json:"baseUrl,omitempty"`

	// instance id (concrete instance)
	// Required: true
	ID *string `json:"id"`

	// if true then the key deriver is visible to every other organization
	IsPublic *bool `json:"isPublic,omitempty"`

	// service id (virtual service id)
	// Required: true
	ServiceIds []string `json:"serviceIds"`

	// version
	// Required: true
	Version *string `json:"version"`
}

KeyDerivationInstance key derivation instance swagger:model KeyDerivationInstance

func (*KeyDerivationInstance) MarshalBinary 

func (m *KeyDerivationInstance) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*KeyDerivationInstance) UnmarshalBinary 

func (m *KeyDerivationInstance) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*KeyDerivationInstance) Validate 

func (m *KeyDerivationInstance) Validate(formats strfmt.Registry) error

Validate validates this key derivation instance

type Log 

type Log struct {

	// client Id
	// Required: true
	ClientID *string `json:"clientId"`

	// event
	// Required: true
	Event *string `json:"event"`
}

Log log swagger:model Log

func (*Log) MarshalBinary 

func (m *Log) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Log) UnmarshalBinary 

func (m *Log) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Log) Validate 

func (m *Log) Validate(formats strfmt.Registry) error

Validate validates this log

type LoginResponse 

type LoginResponse struct {

	// org
	Org *Organization `json:"Org,omitempty"`

	// if set, please display this message to the user on login
	MessageOftheDay string `json:"messageOftheDay,omitempty"`

	// if true, then the user is not attached to an existing org, and must create a new org
	MustCreateOrg bool `json:"mustCreateOrg,omitempty"`
}

LoginResponse login response swagger:model LoginResponse

func (*LoginResponse) MarshalBinary 

func (m *LoginResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LoginResponse) UnmarshalBinary 

func (m *LoginResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LoginResponse) Validate 

func (m *LoginResponse) Validate(formats strfmt.Registry) error

Validate validates this login response

type ManualAuthNParameters added in v0.1.1 

type ManualAuthNParameters struct {

	// public key
	// Required: true
	PublicKey *PublicKey `json:"publicKey"`
}

ManualAuthNParameters manual auth n parameters swagger:model ManualAuthNParameters

func (*ManualAuthNParameters) MarshalBinary added in v0.1.1 

func (m *ManualAuthNParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ManualAuthNParameters) UnmarshalBinary added in v0.1.1 

func (m *ManualAuthNParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ManualAuthNParameters) Validate added in v0.1.1 

func (m *ManualAuthNParameters) Validate(formats strfmt.Registry) error

Validate validates this manual auth n parameters

type OIDCAuthNParameters added in v0.1.1 

type OIDCAuthNParameters struct {

	// client Id
	// Required: true
	ClientID *string `json:"clientId"`

	// url
	// Required: true
	URL *string `json:"url"`
}

OIDCAuthNParameters o ID c auth n parameters swagger:model OIDCAuthNParameters

func (*OIDCAuthNParameters) MarshalBinary added in v0.1.1 

func (m *OIDCAuthNParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OIDCAuthNParameters) UnmarshalBinary added in v0.1.1 

func (m *OIDCAuthNParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OIDCAuthNParameters) Validate added in v0.1.1 

func (m *OIDCAuthNParameters) Validate(formats strfmt.Registry) error

Validate validates this o ID c auth n parameters

type Organization 

type Organization struct {

	// Array of api keys registered to this org
	// Required: true
	APIKeys []*APIKey `json:"apiKeys"`

	// Array of first 10 client id's registered to this org
	// Required: true
	ClientIds []string `json:"clientIds"`

	// contacts
	// Required: true
	Contacts []*Contact `json:"contacts"`

	// cryptoconfigId of this org
	// Required: true
	CryptoConfigID *string `json:"cryptoConfigId"`

	// id
	// Required: true
	ID *string `json:"id"`

	// Array of manual auth params registered to this org
	ManualParams []*ManualAuthNParameters `json:"manualParams"`

	// name
	// Required: true
	Name *string `json:"name"`

	// Number of registered clients to this org
	NumberOfRegisteredClients int64 `json:"numberOfRegisteredClients,omitempty"`

	// Array of OIDC params registered to this org
	OidcParams []*OIDCAuthNParameters `json:"oidcParams"`

	// Identifies the the customer in Stripe associated with this org
	// Required: true
	StripeCustomerID *string `json:"stripeCustomerId"`
}

Organization organization swagger:model Organization

func (*Organization) MarshalBinary 

func (m *Organization) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Organization) UnmarshalBinary 

func (m *Organization) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Organization) Validate 

func (m *Organization) Validate(formats strfmt.Registry) error

Validate validates this organization

type PagedArray added in v0.0.9 

type PagedArray struct {

	// The current page's elements
	Elements []string `json:"elements"`

	// Current page of these elements
	PageNumber int64 `json:"pageNumber,omitempty"`

	// The max number of elements on a page
	PageSize int64 `json:"pageSize,omitempty"`
}

PagedArray paged array swagger:model PagedArray

func (*PagedArray) MarshalBinary added in v0.0.9 

func (m *PagedArray) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PagedArray) UnmarshalBinary added in v0.0.9 

func (m *PagedArray) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PagedArray) Validate added in v0.0.9 

func (m *PagedArray) Validate(formats strfmt.Registry) error

Validate validates this paged array

type PricingPlan added in v0.1.1 

type PricingPlan struct {

	// billing interval seconds
	// Required: true
	BillingIntervalSeconds *int64 `json:"billingIntervalSeconds"`

	// number of keys included
	// Required: true
	NumberOfKeysIncluded *int64 `json:"numberOfKeysIncluded"`

	// price
	// Required: true
	Price *int64 `json:"price"`

	// stripe plan ID
	// Required: true
	StripePlanID *string `json:"stripePlanID"`

	// stripe product ID
	// Required: true
	StripeProductID *string `json:"stripeProductID"`
}

PricingPlan pricing plan swagger:model PricingPlan

func (*PricingPlan) MarshalBinary added in v0.1.1 

func (m *PricingPlan) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PricingPlan) UnmarshalBinary added in v0.1.1 

func (m *PricingPlan) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PricingPlan) Validate added in v0.1.1 

func (m *PricingPlan) Validate(formats strfmt.Registry) error

Validate validates this pricing plan

type PublicKey 

type PublicKey struct {

	// creation time
	// Required: true
	CreationTime *int64 `json:"creationTime"`

	// encoding
	// Required: true
	Encoding *string `json:"encoding"`

	// id
	// Required: true
	ID *string `json:"id"`

	// key
	// Required: true
	Key *string `json:"key"`

	// key type
	// Required: true
	KeyType *string `json:"keyType"`

	// the id of the client that owns this specific public key
	OwningClientID string `json:"owningClientId,omitempty"`

	// the id of the org that owns the client that owns this specific public key
	OwningOrgID string `json:"owningOrgId,omitempty"`
}

PublicKey public key swagger:model PublicKey

func (*PublicKey) MarshalBinary 

func (m *PublicKey) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PublicKey) UnmarshalBinary 

func (m *PublicKey) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PublicKey) Validate 

func (m *PublicKey) Validate(formats strfmt.Registry) error

Validate validates this public key

type SymmetricKeyRequest 

type SymmetricKeyRequest struct {

	// Epoch time of the symmetric key requestion request time.
	// Required: true
	CreationTime *int64 `json:"creationTime"`

	// These are the keyId's to deliver all of the derived symmetric keys.
	// Required: true
	DeliveryPublicKeyIds []string `json:"deliveryPublicKeyIds"`

	// These are the keyId's of for the symmetric keys to actually derive.
	// Required: true
	DeriveSymmetricKeyIds []string `json:"deriveSymmetricKeyIds"`

	// Id of the symmetric key request.
	// Required: true
	ID *string `json:"id"`

	// The serviceId that must generate these keys.
	// Required: true
	KeyDerivationServiceID *string `json:"keyDerivationServiceId"`

	// If true the key deriver must sign delivered symmetric keys ciphertext blobs
	// Required: true
	MustSignDeliveredSymmetricKeys *bool `json:"mustSignDeliveredSymmetricKeys"`

	// After deriving symmetric keys, this determines the ciphertext packaging scheme required for encrypted key delivery.
	// Required: true
	PackagedCiphertextVersion *int64 `json:"packagedCiphertextVersion"`

	// Length in bytes of the derived symmetric keys.
	// Required: true
	SymmetricKeyLength *int64 `json:"symmetricKeyLength"`
}

SymmetricKeyRequest symmetric key request swagger:model SymmetricKeyRequest

func (*SymmetricKeyRequest) MarshalBinary 

func (m *SymmetricKeyRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymmetricKeyRequest) UnmarshalBinary 

func (m *SymmetricKeyRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymmetricKeyRequest) Validate 

func (m *SymmetricKeyRequest) Validate(formats strfmt.Registry) error

Validate validates this symmetric key request

type SymmetricKeyUseDomain 

type SymmetricKeyUseDomain struct {

	// orgs other than the owner that are allowed to use this use domain
	// Required: true
	CollaboratingOrgs []*TinyOrg `json:"collaboratingOrgs"`

	// creation time
	// Required: true
	CreationTime *int64 `json:"creationTime"`

	// The digest algorithm to use for signing messages in this use domain
	DigestAlgorithm *string `json:"digestAlgorithm,omitempty"`

	// after encrypting new plaintexts, package the ciphertext with this version of the packaged ciphertext
	// Required: true
	EncryptingPackagedCiphertextVersion *int64 `json:"encryptingPackagedCiphertextVersion"`

	// these are the semmetric key id's that belong to this use domain - these keys never belong to any other use domain
	// Required: true
	EncryptionKeyIds []string `json:"encryptionKeyIds"`

	// if all registered kds service become unreachable, then incoming requests for new and existing keys may fallback to the cloud provided KDS
	// Required: true
	EndableKDSFallbackToCloud *bool `json:"endableKDSFallbackToCloud"`

	// id
	// Required: true
	ID *string `json:"id"`

	// name
	Name string `json:"name,omitempty"`

	// the org id of the organization that owns these symmetric keys
	// Required: true
	OwnerOrgID *string `json:"ownerOrgId"`

	// if required, all clients must receive these keys in a signed symmetric key delivery from the key deriver
	// Required: true
	RequireSignedKeyDelivery *bool `json:"requireSignedKeyDelivery"`

	// whether this use domain is available for decryption; if false, these keys should not be used for decrypting messages
	SymmetricKeyDecryptionAllowed bool `json:"symmetricKeyDecryptionAllowed,omitempty"`

	// number of seconds since key creation that the key will be available for decryption
	// Required: true
	SymmetricKeyDecryptionUseTTL *int64 `json:"symmetricKeyDecryptionUseTTL"`

	// the symmetric key derivation serivce id that can derive and wrap these keys
	// Required: true
	SymmetricKeyDerivationServiceID *string `json:"symmetricKeyDerivationServiceId"`

	// the specific encryption alg to encrypt new plaintexts for application layer encryption operations
	// Required: true
	SymmetricKeyEncryptionAlg *string `json:"symmetricKeyEncryptionAlg"`

	// whether this use domain is available for encryption; if false, these keys should not be used for encrypting new messages
	SymmetricKeyEncryptionAllowed bool `json:"symmetricKeyEncryptionAllowed,omitempty"`

	// number of seconds since key creation that the key will be available for encryption
	// Required: true
	SymmetricKeyEncryptionUseTTL *int64 `json:"symmetricKeyEncryptionUseTTL"`

	// number of seconds since key creation that the key will be available for encryption
	// Required: true
	SymmetricKeyInceptionTTL *int64 `json:"symmetricKeyInceptionTTL"`

	// the number of bits of all symmetric keys in this use domain
	// Required: true
	SymmetricKeyLength *int64 `json:"symmetricKeyLength"`

	// number of seconds since key creation that the key will be available for retention purposes
	// Required: true
	SymmetricKeyRetentionUseTTL *int64 `json:"symmetricKeyRetentionUseTTL"`
}

SymmetricKeyUseDomain symmetric key use domain swagger:model SymmetricKeyUseDomain

func (*SymmetricKeyUseDomain) MarshalBinary 

func (m *SymmetricKeyUseDomain) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymmetricKeyUseDomain) UnmarshalBinary 

func (m *SymmetricKeyUseDomain) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymmetricKeyUseDomain) Validate 

func (m *SymmetricKeyUseDomain) Validate(formats strfmt.Registry) error

Validate validates this symmetric key use domain

type TinyOrg added in v0.1.1 

type TinyOrg struct {

	// id
	// Required: true
	ID *string `json:"id"`

	// name
	// Required: true
	Name *string `json:"name"`
}

TinyOrg tiny org swagger:model TinyOrg

func (*TinyOrg) MarshalBinary added in v0.1.1 

func (m *TinyOrg) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TinyOrg) UnmarshalBinary added in v0.1.1 

func (m *TinyOrg) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TinyOrg) Validate added in v0.1.1 

func (m *TinyOrg) Validate(formats strfmt.Registry) error

Validate validates this tiny org

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.