mirror of
https://github.com/Infisical/infisical.git
synced 2025-07-20 01:48:03 +00:00
Compare commits
10 Commits
add-folder
...
daniel/go-
Author | SHA1 | Date | |
---|---|---|---|
a61e92c49c | |||
fa05639592 | |||
6c596092b0 | |||
fcd13eac8a | |||
1fb653754c | |||
bb1d73b0f5 | |||
59e9226d85 | |||
e6f42e1231 | |||
e5b7ebbabf | |||
9d46c269d4 |
@ -1,7 +1,6 @@
|
|||||||
ARG POSTHOG_HOST=https://app.posthog.com
|
ARG POSTHOG_HOST=https://app.posthog.com
|
||||||
ARG POSTHOG_API_KEY=posthog-api-key
|
ARG POSTHOG_API_KEY=posthog-api-key
|
||||||
ARG INTERCOM_ID=intercom-id
|
ARG INTERCOM_ID=intercom-id
|
||||||
ARG SAML_ORG_SLUG=saml-org-slug-default
|
|
||||||
|
|
||||||
FROM node:20-alpine AS base
|
FROM node:20-alpine AS base
|
||||||
|
|
||||||
@ -35,9 +34,7 @@ ENV NEXT_PUBLIC_POSTHOG_API_KEY $POSTHOG_API_KEY
|
|||||||
ARG INTERCOM_ID
|
ARG INTERCOM_ID
|
||||||
ENV NEXT_PUBLIC_INTERCOM_ID $INTERCOM_ID
|
ENV NEXT_PUBLIC_INTERCOM_ID $INTERCOM_ID
|
||||||
ARG INFISICAL_PLATFORM_VERSION
|
ARG INFISICAL_PLATFORM_VERSION
|
||||||
ENV NEXT_PUBLIC_INFISICAL_PLATFORM_VERSION $INFISICAL_PLATFORM_VERSION
|
ENV NEXT_PUBLIC_INFISICAL_PLATFORM_VERSION $INFISICAL_PLATFORM_VERSION
|
||||||
ARG SAML_ORG_SLUG
|
|
||||||
ENV NEXT_PUBLIC_SAML_ORG_SLUG=$SAML_ORG_SLUG
|
|
||||||
|
|
||||||
# Build
|
# Build
|
||||||
RUN npm run build
|
RUN npm run build
|
||||||
@ -113,9 +110,6 @@ ENV NEXT_PUBLIC_POSTHOG_API_KEY=$POSTHOG_API_KEY \
|
|||||||
ARG INTERCOM_ID=intercom-id
|
ARG INTERCOM_ID=intercom-id
|
||||||
ENV NEXT_PUBLIC_INTERCOM_ID=$INTERCOM_ID \
|
ENV NEXT_PUBLIC_INTERCOM_ID=$INTERCOM_ID \
|
||||||
BAKED_NEXT_PUBLIC_INTERCOM_ID=$INTERCOM_ID
|
BAKED_NEXT_PUBLIC_INTERCOM_ID=$INTERCOM_ID
|
||||||
ARG SAML_ORG_SLUG
|
|
||||||
ENV NEXT_PUBLIC_SAML_ORG_SLUG=$SAML_ORG_SLUG \
|
|
||||||
BAKED_NEXT_PUBLIC_SAML_ORG_SLUG=$SAML_ORG_SLUG
|
|
||||||
|
|
||||||
WORKDIR /
|
WORKDIR /
|
||||||
|
|
||||||
|
@ -75,6 +75,7 @@ const envSchema = z
|
|||||||
.optional()
|
.optional()
|
||||||
.default(process.env.URL_GITLAB_LOGIN ?? GITLAB_URL)
|
.default(process.env.URL_GITLAB_LOGIN ?? GITLAB_URL)
|
||||||
), // fallback since URL_GITLAB_LOGIN has been renamed
|
), // fallback since URL_GITLAB_LOGIN has been renamed
|
||||||
|
DEFAULT_SAML_ORG_SLUG: zpStr(z.string().optional()).default(process.env.NEXT_PUBLIC_SAML_ORG_SLUG),
|
||||||
// integration client secrets
|
// integration client secrets
|
||||||
// heroku
|
// heroku
|
||||||
CLIENT_ID_HEROKU: zpStr(z.string().optional()),
|
CLIENT_ID_HEROKU: zpStr(z.string().optional()),
|
||||||
@ -131,7 +132,8 @@ const envSchema = z
|
|||||||
isSecretScanningConfigured:
|
isSecretScanningConfigured:
|
||||||
Boolean(data.SECRET_SCANNING_GIT_APP_ID) &&
|
Boolean(data.SECRET_SCANNING_GIT_APP_ID) &&
|
||||||
Boolean(data.SECRET_SCANNING_PRIVATE_KEY) &&
|
Boolean(data.SECRET_SCANNING_PRIVATE_KEY) &&
|
||||||
Boolean(data.SECRET_SCANNING_WEBHOOK_SECRET)
|
Boolean(data.SECRET_SCANNING_WEBHOOK_SECRET),
|
||||||
|
samlDefaultOrgSlug: data.DEFAULT_SAML_ORG_SLUG
|
||||||
}));
|
}));
|
||||||
|
|
||||||
let envCfg: Readonly<z.infer<typeof envSchema>>;
|
let envCfg: Readonly<z.infer<typeof envSchema>>;
|
||||||
|
@ -919,7 +919,8 @@ export const registerRoutes = async (
|
|||||||
emailConfigured: z.boolean().optional(),
|
emailConfigured: z.boolean().optional(),
|
||||||
inviteOnlySignup: z.boolean().optional(),
|
inviteOnlySignup: z.boolean().optional(),
|
||||||
redisConfigured: z.boolean().optional(),
|
redisConfigured: z.boolean().optional(),
|
||||||
secretScanningConfigured: z.boolean().optional()
|
secretScanningConfigured: z.boolean().optional(),
|
||||||
|
samlDefaultOrgSlug: z.string().optional()
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -932,7 +933,8 @@ export const registerRoutes = async (
|
|||||||
emailConfigured: cfg.isSmtpConfigured,
|
emailConfigured: cfg.isSmtpConfigured,
|
||||||
inviteOnlySignup: Boolean(serverCfg.allowSignUp),
|
inviteOnlySignup: Boolean(serverCfg.allowSignUp),
|
||||||
redisConfigured: cfg.isRedisConfigured,
|
redisConfigured: cfg.isRedisConfigured,
|
||||||
secretScanningConfigured: cfg.isSecretScanningConfigured
|
secretScanningConfigured: cfg.isSecretScanningConfigured,
|
||||||
|
samlDefaultOrgSlug: cfg.samlDefaultOrgSlug
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
@ -384,6 +384,7 @@
|
|||||||
"pages": [
|
"pages": [
|
||||||
"sdks/languages/node",
|
"sdks/languages/node",
|
||||||
"sdks/languages/python",
|
"sdks/languages/python",
|
||||||
|
"sdks/languages/go",
|
||||||
"sdks/languages/java",
|
"sdks/languages/java",
|
||||||
"sdks/languages/csharp"
|
"sdks/languages/csharp"
|
||||||
]
|
]
|
||||||
|
438
docs/sdks/languages/go.mdx
Normal file
438
docs/sdks/languages/go.mdx
Normal file
@ -0,0 +1,438 @@
|
|||||||
|
---
|
||||||
|
title: "Infisical Go SDK"
|
||||||
|
sidebarTitle: "Go"
|
||||||
|
icon: "golang"
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
If you're working with Go Lang, the official [Infisical Go SDK](https://github.com/infisical/go-sdk) package is the easiest way to fetch and work with secrets for your application.
|
||||||
|
|
||||||
|
- [Package](https://pkg.go.dev/github.com/infisical/go-sdk)
|
||||||
|
- [Github Repository](https://github.com/infiscial/go-sdk)
|
||||||
|
|
||||||
|
## Basic Usage
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
infisical "github.com/infisical/go-sdk"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
|
||||||
|
client, err := infisical.NewInfisicalClient(infisical.Config{
|
||||||
|
SiteUrl: "https://app.infisical.com", // Optional, default is https://app.infisical.com
|
||||||
|
})
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf("Error: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = client.Auth().UniversalAuthLogin("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf("Authentication failed: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
apiKeySecret, err := client.Secrets().Retrieve(infisical.RetrieveSecretOptions{
|
||||||
|
SecretKey: "API_KEY",
|
||||||
|
Environment: "dev",
|
||||||
|
ProjectID: "YOUR_PROJECT_ID",
|
||||||
|
SecretPath: "/",
|
||||||
|
})
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf("Error: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Printf("API Key Secret: %v", apiKeySecret)
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This example demonstrates how to use the Infisical Go SDK in a simple Go application. The application retrieves a secret named `API_KEY` from the `dev` environment of the `YOUR_PROJECT_ID` project.
|
||||||
|
|
||||||
|
<Warning>
|
||||||
|
We do not recommend hardcoding your [Machine Identity Tokens](/platform/identities/overview). Setting it as an environment variable would be best.
|
||||||
|
</Warning>
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ go get github.com/infisical/go-sdk
|
||||||
|
```
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
Import the SDK and create a client instance.
|
||||||
|
|
||||||
|
```go
|
||||||
|
client, err := infisical.NewInfisicalClient(infisical.Config{
|
||||||
|
SiteUrl: "https://app.infisical.com", // Optional, default is https://api.infisical.com
|
||||||
|
})
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Printf("Error: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### ClientSettings methods
|
||||||
|
|
||||||
|
<ParamField query="options" type="object">
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="SiteUrl" type="string" optional>
|
||||||
|
The URL of the Infisical API. Default is `https://api.infisical.com`.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="UserAgent" type="string" required>
|
||||||
|
Optionally set the user agent that will be used for HTTP requests. _(Not recommended)_
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
### Authentication
|
||||||
|
|
||||||
|
The SDK supports a variety of authentication methods. The most common authentication method is Universal Auth, which uses a client ID and client secret to authenticate.
|
||||||
|
|
||||||
|
#### Universal Auth
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().UniversalAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID` - Your machine identity client ID.
|
||||||
|
- `INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET` - Your machine identity client secret.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
_, err := client.Auth().UniversalAuthLogin("CLIENT_ID", "CLIENT_SECRET")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### GCP ID Token Auth
|
||||||
|
<Info>
|
||||||
|
Please note that this authentication method will only work if you're running your application on Google Cloud Platform.
|
||||||
|
Please [read more](/documentation/platform/identities/gcp-auth) about this authentication method.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().GcpIdTokenAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_GCP_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
_, err := client.Auth().GcpIdTokenAuthLogin("YOUR_MACHINE_IDENTITY_ID")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### GCP IAM Auth
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().GcpIamAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_GCP_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.
|
||||||
|
- `INFISICAL_GCP_IAM_SERVICE_ACCOUNT_KEY_FILE_PATH` - The path to your GCP service account key file.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
_, err = client.Auth().GcpIamAuthLogin("MACHINE_IDENTITY_ID", "SERVICE_ACCOUNT_KEY_FILE_PATH")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### AWS IAM Auth
|
||||||
|
<Info>
|
||||||
|
Please note that this authentication method will only work if you're running your application on AWS.
|
||||||
|
Please [read more](/documentation/platform/identities/aws-auth) about this authentication method.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().AwsIamAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_AWS_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
_, err = client.Auth().AwsIamAuthLogin("MACHINE_IDENTITY_ID")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Azure Auth
|
||||||
|
<Info>
|
||||||
|
Please note that this authentication method will only work if you're running your application on Azure.
|
||||||
|
Please [read more](/documentation/platform/identities/azure-auth) about this authentication method.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().AzureAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_AZURE_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
_, err = client.Auth().AzureAuthLogin("MACHINE_IDENTITY_ID")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Kubernetes Auth
|
||||||
|
<Info>
|
||||||
|
Please note that this authentication method will only work if you're running your application on Kubernetes.
|
||||||
|
Please [read more](/documentation/platform/identities/kubernetes-auth) about this authentication method.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
**Using environment variables**
|
||||||
|
|
||||||
|
Call `.Auth().KubernetesAuthLogin()` with empty arguments to use the following environment variables:
|
||||||
|
|
||||||
|
- `INFISICAL_KUBERNETES_IDENTITY_ID` - Your Infisical Machine Identity ID.
|
||||||
|
- `INFISICAL_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH_ENV_NAME` - The environment variable name that contains the path to the service account token. This is optional and will default to `/var/run/secrets/kubernetes.io/serviceaccount/token`.
|
||||||
|
|
||||||
|
**Using the SDK directly**
|
||||||
|
```go
|
||||||
|
// Service account token path will default to /var/run/secrets/kubernetes.io/serviceaccount/token if empty value is passed
|
||||||
|
_, err = client.Auth().KubernetesAuthLogin("MACHINE_IDENTITY_ID", "SERVICE_ACCOUNT_TOKEN_PATH")
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Working with Secrets
|
||||||
|
|
||||||
|
### client.Secrets().List(options)
|
||||||
|
|
||||||
|
```go
|
||||||
|
secrets, err := client.Secrets().List(infisical.ListSecretsOptions{
|
||||||
|
ProjectID: "PROJECT_ID",
|
||||||
|
Environment: "dev",
|
||||||
|
SecretPath: "/foo/bar",
|
||||||
|
AttachToProcessEnv: false,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Retrieve all secrets within the Infisical project and environment that client is connected to
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<ParamField query="Parameters" type="object">
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="Environment" type="string" required>
|
||||||
|
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="ProjectID" type="string">
|
||||||
|
The project ID where the secret lives in.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="SecretPath" type="string" optional>
|
||||||
|
The path from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="AttachToProcessEnv" type="boolean" default="false" optional>
|
||||||
|
Whether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `System.getenv("SECRET_NAME")`.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="IncludeImports" type="boolean" default="false" optional>
|
||||||
|
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="Recursive" type="boolean" default="false" optional>
|
||||||
|
Whether or not to fetch secrets recursively from the specified path. Please note that there's a 20-depth limit for recursive fetching.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
<ParamField query="ExpandSecretReferences" type="boolean" default="true" optional>
|
||||||
|
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
### client.Secrets().Get(options)
|
||||||
|
|
||||||
|
```go
|
||||||
|
secret, err := client.Secrets().Retrieve(infisical.RetrieveSecretOptions{
|
||||||
|
SecretKey: "API_KEY",
|
||||||
|
ProjectID: "PROJECT_ID",
|
||||||
|
Environment: "dev",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Retrieve a secret from Infisical.
|
||||||
|
|
||||||
|
By default, `Secrets().Get()` fetches and returns a shared secret.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<ParamField query="Parameters" type="object" optional>
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="SecretKey" type="string" required>
|
||||||
|
The key of the secret to retrieve.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="ProjectID" type="string" required>
|
||||||
|
The project ID where the secret lives in.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Environment" type="string" required>
|
||||||
|
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretPath" type="string" optional>
|
||||||
|
The path from where secret should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Type" type="string" optional>
|
||||||
|
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
### client.Secrets().Create(options)
|
||||||
|
|
||||||
|
```go
|
||||||
|
secret, err := client.Secrets().Create(infisical.CreateSecretOptions{
|
||||||
|
ProjectID: "PROJECT_ID",
|
||||||
|
Environment: "dev",
|
||||||
|
|
||||||
|
SecretKey: "NEW_SECRET_KEY",
|
||||||
|
SecretValue: "NEW_SECRET_VALUE",
|
||||||
|
SecretComment: "This is a new secret",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a new secret in Infisical.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<ParamField query="Parameters" type="object" optional>
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="SecretKey" type="string" required>
|
||||||
|
The key of the secret to create.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretValue" type="string" required>
|
||||||
|
The value of the secret.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretComment" type="string" optional>
|
||||||
|
A comment for the secret.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="ProjectID" type="string" required>
|
||||||
|
The project ID where the secret lives in.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Environment" type="string" required>
|
||||||
|
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretPath" type="string" optional>
|
||||||
|
The path from where secret should be created.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Type" type="string" optional>
|
||||||
|
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
### client.Secrets().Update(options)
|
||||||
|
|
||||||
|
```go
|
||||||
|
secret, err := client.Secrets().Update(infisical.UpdateSecretOptions{
|
||||||
|
ProjectID: "PROJECT_ID",
|
||||||
|
Environment: "dev",
|
||||||
|
SecretKey: "NEW_SECRET_KEY",
|
||||||
|
NewSecretValue: "NEW_SECRET_VALUE",
|
||||||
|
NewSkipMultilineEncoding: false,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Update an existing secret in Infisical.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<ParamField query="Parameters" type="object" optional>
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="SecretKey" type="string" required>
|
||||||
|
The key of the secret to update.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="NewSecretValue" type="string" required>
|
||||||
|
The new value of the secret.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="NewSkipMultilineEncoding" type="boolean" default="false" optional>
|
||||||
|
Whether or not to skip multiline encoding for the new secret value.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="ProjectID" type="string" required>
|
||||||
|
The project ID where the secret lives in.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Environment" type="string" required>
|
||||||
|
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretPath" type="string" optional>
|
||||||
|
The path from where secret should be updated.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Type" type="string" optional>
|
||||||
|
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
|
### client.Secrets().Delete(options)
|
||||||
|
|
||||||
|
```go
|
||||||
|
secret, err := client.Secrets().Delete(infisical.DeleteSecretOptions{
|
||||||
|
ProjectID: "PROJECT_ID",
|
||||||
|
Environment: "dev",
|
||||||
|
SecretKey: "SECRET_KEY",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Delete a secret in Infisical.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<ParamField query="Parameters" type="object" optional>
|
||||||
|
<Expandable title="properties">
|
||||||
|
<ParamField query="SecretKey" type="string">
|
||||||
|
The key of the secret to update.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="ProjectID" type="string" required>
|
||||||
|
The project ID where the secret lives in.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Environment" type="string" required>
|
||||||
|
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="SecretPath" type="string" optional>
|
||||||
|
The path from where secret should be deleted.
|
||||||
|
</ParamField>
|
||||||
|
<ParamField query="Type" type="string" optional>
|
||||||
|
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
|
||||||
|
</ParamField>
|
||||||
|
</Expandable>
|
||||||
|
</ParamField>
|
@ -318,6 +318,11 @@ SMTP_FROM_NAME=Infisical
|
|||||||
By default, users can only login via email/password based login method.
|
By default, users can only login via email/password based login method.
|
||||||
To login into Infisical with OAuth providers such as Google, configure the associated variables.
|
To login into Infisical with OAuth providers such as Google, configure the associated variables.
|
||||||
|
|
||||||
|
<ParamField query="DEFAULT_SAML_ORG_SLUG" type="string">
|
||||||
|
|
||||||
|
When set, all visits to the Infisical login page will automatically redirect users of your Infisical instance to the SAML identity provider associated with the specified organization slug.
|
||||||
|
</ParamField>
|
||||||
|
|
||||||
<Accordion title="Google">
|
<Accordion title="Google">
|
||||||
Follow detailed guide to configure [Google SSO](/documentation/platform/sso/google)
|
Follow detailed guide to configure [Google SSO](/documentation/platform/sso/google)
|
||||||
|
|
||||||
@ -369,11 +374,6 @@ To login into Infisical with OAuth providers such as Google, configure the assoc
|
|||||||
information.
|
information.
|
||||||
</Accordion>
|
</Accordion>
|
||||||
|
|
||||||
<ParamField query="NEXT_PUBLIC_SAML_ORG_SLUG" type="string">
|
|
||||||
Configure SAML organization slug to automatically redirect all users of your
|
|
||||||
Infisical instance to the identity provider.
|
|
||||||
</ParamField>
|
|
||||||
|
|
||||||
## Native secret integrations
|
## Native secret integrations
|
||||||
|
|
||||||
To help you sync secrets from Infisical to services such as Github and Gitlab, Infisical provides native integrations out of the box.
|
To help you sync secrets from Infisical to services such as Github and Gitlab, Infisical provides native integrations out of the box.
|
||||||
|
@ -4,8 +4,6 @@ scripts/replace-standalone-build-variable.sh "$BAKED_NEXT_PUBLIC_POSTHOG_API_KEY
|
|||||||
|
|
||||||
scripts/replace-standalone-build-variable.sh "$BAKED_NEXT_PUBLIC_INTERCOM_ID" "$NEXT_PUBLIC_INTERCOM_ID"
|
scripts/replace-standalone-build-variable.sh "$BAKED_NEXT_PUBLIC_INTERCOM_ID" "$NEXT_PUBLIC_INTERCOM_ID"
|
||||||
|
|
||||||
scripts/replace-standalone-build-variable.sh "$BAKED_NEXT_PUBLIC_SAML_ORG_SLUG" "$NEXT_PUBLIC_SAML_ORG_SLUG"
|
|
||||||
|
|
||||||
if [ "$TELEMETRY_ENABLED" != "false" ]; then
|
if [ "$TELEMETRY_ENABLED" != "false" ]; then
|
||||||
echo "Telemetry is enabled"
|
echo "Telemetry is enabled"
|
||||||
scripts/set-standalone-build-telemetry.sh true
|
scripts/set-standalone-build-telemetry.sh true
|
||||||
|
@ -4,4 +4,5 @@ export type ServerStatus = {
|
|||||||
emailConfigured: boolean;
|
emailConfigured: boolean;
|
||||||
secretScanningConfigured: boolean;
|
secretScanningConfigured: boolean;
|
||||||
redisConfigured: boolean;
|
redisConfigured: boolean;
|
||||||
|
samlDefaultOrgSlug: boolean
|
||||||
};
|
};
|
||||||
|
@ -12,6 +12,7 @@ import attemptCliLogin from "@app/components/utilities/attemptCliLogin";
|
|||||||
import attemptLogin from "@app/components/utilities/attemptLogin";
|
import attemptLogin from "@app/components/utilities/attemptLogin";
|
||||||
import { Button, Input } from "@app/components/v2";
|
import { Button, Input } from "@app/components/v2";
|
||||||
import { useServerConfig } from "@app/context";
|
import { useServerConfig } from "@app/context";
|
||||||
|
import { useFetchServerStatus } from "@app/hooks/api";
|
||||||
|
|
||||||
import { navigateUserToSelectOrg } from "../../Login.utils";
|
import { navigateUserToSelectOrg } from "../../Login.utils";
|
||||||
|
|
||||||
@ -31,21 +32,15 @@ export const InitialStep = ({ setStep, email, setEmail, password, setPassword }:
|
|||||||
const [loginError, setLoginError] = useState(false);
|
const [loginError, setLoginError] = useState(false);
|
||||||
const { config } = useServerConfig();
|
const { config } = useServerConfig();
|
||||||
const queryParams = new URLSearchParams(window.location.search);
|
const queryParams = new URLSearchParams(window.location.search);
|
||||||
|
const { data: serverDetails } = useFetchServerStatus();
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (
|
if (serverDetails?.samlDefaultOrgSlug){
|
||||||
process.env.NEXT_PUBLIC_SAML_ORG_SLUG &&
|
const callbackPort = queryParams.get("callback_port");
|
||||||
process.env.NEXT_PUBLIC_SAML_ORG_SLUG !== "saml-org-slug-default"
|
const redirectUrl = `/api/v1/sso/redirect/saml2/organizations/${serverDetails?.samlDefaultOrgSlug}${callbackPort ? `?callback_port=${callbackPort}` : ""}`
|
||||||
) {
|
router.push(redirectUrl);
|
||||||
const callbackPort = queryParams.get("callback_port");
|
}
|
||||||
window.open(
|
}, [serverDetails?.samlDefaultOrgSlug]);
|
||||||
`/api/v1/sso/redirect/saml2/organizations/${process.env.NEXT_PUBLIC_SAML_ORG_SLUG}${
|
|
||||||
callbackPort ? `?callback_port=${callbackPort}` : ""
|
|
||||||
}`
|
|
||||||
);
|
|
||||||
window.close();
|
|
||||||
}
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const handleLogin = async (e: FormEvent<HTMLFormElement>) => {
|
const handleLogin = async (e: FormEvent<HTMLFormElement>) => {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
|
@ -178,7 +178,7 @@ export const AddShareSecretModal = ({ popUp, handlePopUpToggle }: Props) => {
|
|||||||
errorText={error?.message}
|
errorText={error?.message}
|
||||||
>
|
>
|
||||||
<SecretInput
|
<SecretInput
|
||||||
isVisible
|
isVisible={false}
|
||||||
{...field}
|
{...field}
|
||||||
containerClassName="py-1.5 rounded-md transition-all group-hover:mr-2 text-bunker-300 hover:border-primary-400/50 border border-mineshaft-600 bg-mineshaft-900 px-2 min-h-[100px]"
|
containerClassName="py-1.5 rounded-md transition-all group-hover:mr-2 text-bunker-300 hover:border-primary-400/50 border border-mineshaft-600 bg-mineshaft-900 px-2 min-h-[100px]"
|
||||||
/>
|
/>
|
||||||
|
Reference in New Issue
Block a user