Documentation ¶
Index ¶
- Constants
- type AuthMethod
- type Client
- func (c *Client) CreateFolder(workspaceID, environment, name string, params ParamsCreateFolder) (result FolderData, err error)
- func (c *Client) CreateSecret(workspaceID, environment, secretKey, secretValue string, ...) (err error)
- func (c *Client) DeleteFolder(workspaceID, environment, folderID string, params ParamsDeleteFolder) (result FolderData, err error)
- func (c *Client) DeleteSecret(workspaceID, environment, secretKey string, params ParamsDeleteSecret) (err error)
- func (c *Client) ListFolders(workspaceID, environment string, params ParamsListFolders) (result FoldersData, err error)
- func (c *Client) ListSecrets(params ParamsListSecrets) (result SecretsData, err error)
- func (c *Client) RetrieveOrganizations() (result OrganizationsData, err error)
- func (c *Client) RetrieveProjects(organizationID string) (result ProjectsData, err error)
- func (c *Client) RetrieveSecret(workspaceID, environment, secretKey string, params ParamsRetrieveSecret) (result SecretData, err error)
- func (c *Client) RetrieveSecretValue(workspaceID, environment string, secretType SecretType, ...) (value string, err error)
- func (c *Client) SetAPIBaseURL(baseURL string)
- func (c *Client) UpdateFolder(workspaceID, environment, folderID, name string, params ParamsUpdateFolder) (result FolderData, err error)
- func (c *Client) UpdateSecret(workspaceID, environment, secretKey, secretValue string, ...) (err error)
- type Folder
- type FolderData
- type FoldersData
- type Organization
- type OrganizationsData
- type ParamsCreateFolder
- type ParamsCreateSecret
- type ParamsDeleteFolder
- type ParamsDeleteSecret
- type ParamsListFolders
- type ParamsListSecrets
- func (p ParamsListSecrets) SetEnvironment(environment string) ParamsListSecrets
- func (p ParamsListSecrets) SetIncludeImports(includeImports bool) ParamsListSecrets
- func (p ParamsListSecrets) SetSecretPath(secretPath string) ParamsListSecrets
- func (p ParamsListSecrets) SetWorkspaceID(workspaceID string) ParamsListSecrets
- type ParamsRetrieveSecret
- type ParamsUpdateFolder
- type ParamsUpdateSecret
- type ProjectsData
- type Secret
- type SecretData
- type SecretImport
- type SecretType
- type SecretsData
- type UniversalAuthToken
- type Workspace
- type WorkspaceEnvironment
Constants ¶
const ( DefaultAPIBaseURL = "https://app.infisical.com" TimeoutSeconds = 10 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthMethod ¶
type AuthMethod int
const ( AuthMethodNormal AuthMethod = 0 AuthMethodAPIKeyOnly AuthMethod = 1 << iota AuthMethodTokenOnly AuthMethod = 1 << iota )
type Client ¶
type Client struct { Verbose bool // NOTE: set `true` for dumping http requests & responses // contains filtered or unexported fields }
Client struct
func NewClientWithoutAPIKey ¶
NewClientWithoutAPIKey creates and returns a new client only with tokens.
func (*Client) CreateFolder ¶
func (c *Client) CreateFolder(workspaceID, environment, name string, params ParamsCreateFolder) (result FolderData, err error)
CreateFolder creates a new folder with given parameters.
https://infisical.com/docs/api-reference/endpoints/folders/create
func (*Client) CreateSecret ¶
func (c *Client) CreateSecret(workspaceID, environment, secretKey, secretValue string, params ParamsCreateSecret) (err error)
CreateSecret creates a secret with given parameters.
https://infisical.com/docs/api-reference/endpoints/secrets/create
func (*Client) DeleteFolder ¶
func (c *Client) DeleteFolder(workspaceID, environment, folderID string, params ParamsDeleteFolder) (result FolderData, err error)
DeleteFolder deletes a folder with given parameters.
https://infisical.com/docs/api-reference/endpoints/folders/delete
func (*Client) DeleteSecret ¶
func (c *Client) DeleteSecret(workspaceID, environment, secretKey string, params ParamsDeleteSecret) (err error)
DeleteSecret deletes a secret for given parameters.
https://infisical.com/docs/api-reference/endpoints/secrets/delete
func (*Client) ListFolders ¶
func (c *Client) ListFolders(workspaceID, environment string, params ParamsListFolders) (result FoldersData, err error)
ListFolders lists folders for given parameters.
https://infisical.com/docs/api-reference/endpoints/folders/list
func (*Client) ListSecrets ¶
func (c *Client) ListSecrets(params ParamsListSecrets) (result SecretsData, err error)
ListSecrets lists all secrets for given parameters.
https://infisical.com/docs/api-reference/endpoints/secrets/list
func (*Client) RetrieveOrganizations ¶
func (c *Client) RetrieveOrganizations() (result OrganizationsData, err error)
RetrieveOrganizations retrieves all my organizations.
(DEPRECATED)
https://infisical.com/docs/api-reference/endpoints/users/my-organizations
func (*Client) RetrieveProjects ¶
func (c *Client) RetrieveProjects(organizationID string) (result ProjectsData, err error)
RetrieveProjects retrieves all workspaces for given organization id.
https://infisical.com/docs/api-reference/endpoints/organizations/workspaces
func (*Client) RetrieveSecret ¶
func (c *Client) RetrieveSecret(workspaceID, environment, secretKey string, params ParamsRetrieveSecret) (result SecretData, err error)
RetrieveSecret retrieves a secret for given parameters.
https://infisical.com/docs/api-reference/endpoints/secrets/read-one
func (*Client) RetrieveSecretValue ¶
func (c *Client) RetrieveSecretValue(workspaceID, environment string, secretType SecretType, secretKeyWithPath string) (value string, err error)
RetrieveSecretValue retrieves a secret value for given path + key.
Just a helper function for `RetrieveSecret`.
`secretKeyWithPath` is in form of: "/folder1/folder2/.../secret_key_name"
func (*Client) SetAPIBaseURL ¶
SetAPIBaseURL changes the `baseURL`.
(eg. for using in self-hosted infisical servers)
func (*Client) UpdateFolder ¶
func (c *Client) UpdateFolder(workspaceID, environment, folderID, name string, params ParamsUpdateFolder) (result FolderData, err error)
UpdateFolder updates a folder with given parameters.
https://infisical.com/docs/api-reference/endpoints/folders/update
func (*Client) UpdateSecret ¶
func (c *Client) UpdateSecret(workspaceID, environment, secretKey, secretValue string, params ParamsUpdateSecret) (err error)
UpdateSecret updates a secret with given parameters.
https://infisical.com/docs/api-reference/endpoints/secrets/update
type Folder ¶
type Folder struct { CreatedAt string `json:"createdAt"` EnvironmentID string `json:"envId"` ID string `json:"id"` Name string `json:"name"` ParentID *string `json:"parentId,omitempty"` UpdatedAt string `json:"updatedAt"` Version int `json:"version,omitempty"` }
Folder struct
type FolderData ¶
type FolderData struct {
Folder Folder `json:"folder"`
}
type FoldersData ¶
type FoldersData struct {
Folders []Folder `json:"folders"`
}
FoldersData struct for folders response
type Organization ¶
type Organization struct { AuthEnforced bool `json:"authEnforced"` CreatedAt string `json:"createdAt"` CustomerID string `json:"customerId"` ID string `json:"id"` Name string `json:"name"` Slug string `json:"slug"` UpdatedAt string `json:"updatedAt"` }
Organization struct for one organization
(DEPRECATED)
https://infisical.com/docs/api-reference/endpoints/users/my-organizations
type OrganizationsData ¶
type OrganizationsData struct {
Organizations []Organization `json:"organizations"`
}
OrganizationsData struct for organizations response
type ParamsCreateFolder ¶
func NewParamsCreateFolder ¶
func NewParamsCreateFolder() ParamsCreateFolder
func (ParamsCreateFolder) SetDirectory ¶
func (p ParamsCreateFolder) SetDirectory(directory string) ParamsCreateFolder
func (ParamsCreateFolder) SetPath ¶
func (p ParamsCreateFolder) SetPath(path string) ParamsCreateFolder
type ParamsCreateSecret ¶
func NewParamsCreateSecret ¶
func NewParamsCreateSecret() ParamsCreateSecret
func (ParamsCreateSecret) SetSecretComment ¶
func (p ParamsCreateSecret) SetSecretComment(secretComment string) ParamsCreateSecret
func (ParamsCreateSecret) SetSecretPath ¶
func (p ParamsCreateSecret) SetSecretPath(secretPath string) ParamsCreateSecret
func (ParamsCreateSecret) SetType ¶
func (p ParamsCreateSecret) SetType(typ SecretType) ParamsCreateSecret
type ParamsDeleteFolder ¶
func NewParamsDeleteFolder ¶
func NewParamsDeleteFolder() ParamsDeleteFolder
func (ParamsDeleteFolder) SetDirectory ¶
func (p ParamsDeleteFolder) SetDirectory(directory string) ParamsDeleteFolder
func (ParamsDeleteFolder) SetPath ¶
func (p ParamsDeleteFolder) SetPath(path string) ParamsDeleteFolder
type ParamsDeleteSecret ¶
func NewParamsDeleteSecret ¶
func NewParamsDeleteSecret() ParamsDeleteSecret
func (ParamsDeleteSecret) SetSecretPath ¶
func (p ParamsDeleteSecret) SetSecretPath(secretPath string) ParamsDeleteSecret
func (ParamsDeleteSecret) SetType ¶
func (p ParamsDeleteSecret) SetType(typ SecretType) ParamsDeleteSecret
type ParamsListFolders ¶
func NewParamsListFolders ¶
func NewParamsListFolders() ParamsListFolders
func (ParamsListFolders) SetDirectory ¶
func (p ParamsListFolders) SetDirectory(directory string) ParamsListFolders
func (ParamsListFolders) SetPath ¶
func (p ParamsListFolders) SetPath(path string) ParamsListFolders
type ParamsListSecrets ¶
func NewParamsListSecrets ¶
func NewParamsListSecrets() ParamsListSecrets
func (ParamsListSecrets) SetEnvironment ¶
func (p ParamsListSecrets) SetEnvironment(environment string) ParamsListSecrets
func (ParamsListSecrets) SetIncludeImports ¶
func (p ParamsListSecrets) SetIncludeImports(includeImports bool) ParamsListSecrets
func (ParamsListSecrets) SetSecretPath ¶
func (p ParamsListSecrets) SetSecretPath(secretPath string) ParamsListSecrets
func (ParamsListSecrets) SetWorkspaceID ¶
func (p ParamsListSecrets) SetWorkspaceID(workspaceID string) ParamsListSecrets
type ParamsRetrieveSecret ¶
func NewParamsRetrieveSecret ¶
func NewParamsRetrieveSecret() ParamsRetrieveSecret
func (ParamsRetrieveSecret) SetSecretPath ¶
func (p ParamsRetrieveSecret) SetSecretPath(secretPath string) ParamsRetrieveSecret
func (ParamsRetrieveSecret) SetType ¶
func (p ParamsRetrieveSecret) SetType(typ SecretType) ParamsRetrieveSecret
type ParamsUpdateFolder ¶
func NewParamsUpdateFolder ¶
func NewParamsUpdateFolder() ParamsUpdateFolder
func (ParamsUpdateFolder) SetDirectory ¶
func (p ParamsUpdateFolder) SetDirectory(directory string) ParamsUpdateFolder
func (ParamsUpdateFolder) SetPath ¶
func (p ParamsUpdateFolder) SetPath(path string) ParamsUpdateFolder
type ParamsUpdateSecret ¶
func NewParamsUpdateSecret ¶
func NewParamsUpdateSecret() ParamsUpdateSecret
func (ParamsUpdateSecret) SetSecretComment ¶
func (p ParamsUpdateSecret) SetSecretComment(comment string) ParamsUpdateSecret
func (ParamsUpdateSecret) SetSecretPath ¶
func (p ParamsUpdateSecret) SetSecretPath(secretPath string) ParamsUpdateSecret
func (ParamsUpdateSecret) SetType ¶
func (p ParamsUpdateSecret) SetType(typ SecretType) ParamsUpdateSecret
type ProjectsData ¶
type ProjectsData struct {
Workspaces []Workspace `json:"workspaces"`
}
ProjectsData struct for projects response
type Secret ¶
type Secret struct { ID_ string `json:"_id"` Environment string `json:"environment"` ID string `json:"id"` SecretComment *string `json:"secretComment,omitempty"` SecretKey string `json:"secretKey"` SecretValue string `json:"secretValue"` Type SecretType `json:"type"` Version int `json:"version"` Workspace string `json:"workspace"` }
Secret struct for one secret
type SecretData ¶
type SecretData struct {
Secret Secret `json:"secret"`
}
SecretData struct for secret response
type SecretImport ¶
type SecretType ¶
type SecretType string
SecretType type and constants
const ( SecretTypePersonal SecretType = "personal" )
type SecretsData ¶
type SecretsData struct { Imports []SecretImport `json:"imports"` Secrets []Secret `json:"secrets"` }
SecretsData struct for secrets response
type UniversalAuthToken ¶
type UniversalAuthToken struct { AccessToken string `json:"accessToken"` AccessTokenMaxTTL int64 `json:"accessTokenMaxTTL"` ExpiresIn int64 `json:"expiresIn"` TokenType string `json:"tokenType"` }
UniversalAuthToken is a struct of universal-auth token
type Workspace ¶
type Workspace struct { ID string `json:"id"` Name string `json:"name"` Organization string `json:"organization"` Environments []WorkspaceEnvironment `json:"environments"` }
Workspace struct for project
type WorkspaceEnvironment ¶
WorkspaceEnvironment struct for environments