mirror of
https://github.com/Infisical/infisical.git
synced 2026-01-10 07:58:15 -05:00
643 lines
21 KiB
JSON
643 lines
21 KiB
JSON
{
|
|
"name": "Infisical",
|
|
"openapi": "https://app.infisical.com/api/docs/json",
|
|
"logo": {
|
|
"dark": "/logo/dark.svg",
|
|
"light": "/logo/light.svg",
|
|
"href": "https://infisical.com"
|
|
},
|
|
"favicon": "/favicon.png",
|
|
"colors": {
|
|
"primary": "#26272b",
|
|
"light": "#97b31d",
|
|
"dark": "#A1B659",
|
|
"ultraLight": "#E7F256",
|
|
"ultraDark": "#8D9F4C",
|
|
"background": {
|
|
"light": "#ffffff",
|
|
"dark": "#0D1117"
|
|
},
|
|
"anchors": {
|
|
"from": "#000000",
|
|
"to": "#707174"
|
|
}
|
|
},
|
|
"modeToggle": {
|
|
"default": "light",
|
|
"isHidden": true
|
|
},
|
|
"feedback": {
|
|
"suggestEdit": true,
|
|
"raiseIssue": true,
|
|
"thumbsRating": true
|
|
},
|
|
"api": {
|
|
"baseUrl": ["https://app.infisical.com", "http://localhost:8080"]
|
|
},
|
|
"topbarLinks": [
|
|
{
|
|
"name": "Log In",
|
|
"url": "https://app.infisical.com/login"
|
|
}
|
|
],
|
|
"topbarCtaButton": {
|
|
"name": "Start for Free",
|
|
"url": "https://app.infisical.com/signup"
|
|
},
|
|
"tabs": [
|
|
{
|
|
"name": "Integrations",
|
|
"url": "integrations"
|
|
},
|
|
{
|
|
"name": "CLI",
|
|
"url": "cli"
|
|
},
|
|
{
|
|
"name": "API Reference",
|
|
"url": "api-reference"
|
|
},
|
|
{
|
|
"name": "SDKs",
|
|
"url": "sdks"
|
|
},
|
|
{
|
|
"name": "Changelog",
|
|
"url": "changelog"
|
|
}
|
|
],
|
|
"navigation": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"documentation/getting-started/introduction",
|
|
{
|
|
"group": "Quickstart",
|
|
"pages": ["documentation/guides/local-development"]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
"documentation/guides/introduction",
|
|
"documentation/guides/node",
|
|
"documentation/guides/python",
|
|
"documentation/guides/nextjs-vercel",
|
|
"documentation/guides/microsoft-power-apps"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Platform",
|
|
"pages": [
|
|
"documentation/platform/organization",
|
|
"documentation/platform/project",
|
|
"documentation/platform/folder",
|
|
{
|
|
"group": "Secrets",
|
|
"pages": [
|
|
"documentation/platform/secret-versioning",
|
|
"documentation/platform/pit-recovery",
|
|
"documentation/platform/secret-reference",
|
|
"documentation/platform/webhooks"
|
|
]
|
|
},
|
|
{
|
|
"group": "Internal PKI",
|
|
"pages": [
|
|
"documentation/platform/pki/overview",
|
|
"documentation/platform/pki/private-ca",
|
|
"documentation/platform/pki/certificates"
|
|
]
|
|
},
|
|
{
|
|
"group": "Identities",
|
|
"pages": [
|
|
"documentation/platform/identities/overview",
|
|
"documentation/platform/identities/user-identities",
|
|
"documentation/platform/identities/machine-identities"
|
|
]
|
|
},
|
|
{
|
|
"group": "Access Control",
|
|
"pages": [
|
|
"documentation/platform/access-controls/overview",
|
|
"documentation/platform/access-controls/role-based-access-controls",
|
|
"documentation/platform/access-controls/additional-privileges",
|
|
"documentation/platform/access-controls/temporary-access",
|
|
"documentation/platform/access-controls/access-requests",
|
|
"documentation/platform/pr-workflows",
|
|
"documentation/platform/audit-logs",
|
|
"documentation/platform/audit-log-streams",
|
|
"documentation/platform/groups"
|
|
]
|
|
},
|
|
{
|
|
"group": "Secret Rotation",
|
|
"pages": [
|
|
"documentation/platform/secret-rotation/overview",
|
|
"documentation/platform/secret-rotation/sendgrid",
|
|
"documentation/platform/secret-rotation/postgres",
|
|
"documentation/platform/secret-rotation/mysql",
|
|
"documentation/platform/secret-rotation/aws-iam"
|
|
]
|
|
},
|
|
{
|
|
"group": "Dynamic Secrets",
|
|
"pages": [
|
|
"documentation/platform/dynamic-secrets/overview",
|
|
"documentation/platform/dynamic-secrets/postgresql",
|
|
"documentation/platform/dynamic-secrets/mysql",
|
|
"documentation/platform/dynamic-secrets/oracle",
|
|
"documentation/platform/dynamic-secrets/cassandra",
|
|
"documentation/platform/dynamic-secrets/aws-iam"
|
|
]
|
|
},
|
|
"documentation/platform/secret-sharing"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication Methods",
|
|
"pages": [
|
|
"documentation/platform/auth-methods/email-password",
|
|
"documentation/platform/token",
|
|
"documentation/platform/identities/universal-auth",
|
|
"documentation/platform/identities/kubernetes-auth",
|
|
"documentation/platform/identities/gcp-auth",
|
|
"documentation/platform/identities/azure-auth",
|
|
"documentation/platform/identities/aws-auth",
|
|
"documentation/platform/mfa",
|
|
{
|
|
"group": "SSO",
|
|
"pages": [
|
|
"documentation/platform/sso/overview",
|
|
"documentation/platform/sso/google",
|
|
"documentation/platform/sso/github",
|
|
"documentation/platform/sso/gitlab",
|
|
"documentation/platform/sso/okta",
|
|
"documentation/platform/sso/azure",
|
|
"documentation/platform/sso/jumpcloud",
|
|
"documentation/platform/sso/keycloak-saml",
|
|
"documentation/platform/sso/google-saml"
|
|
]
|
|
},
|
|
{
|
|
"group": "LDAP",
|
|
"pages": [
|
|
"documentation/platform/ldap/overview",
|
|
"documentation/platform/ldap/jumpcloud",
|
|
"documentation/platform/ldap/general"
|
|
]
|
|
},
|
|
{
|
|
"group": "SCIM",
|
|
"pages": [
|
|
"documentation/platform/scim/overview",
|
|
"documentation/platform/scim/okta",
|
|
"documentation/platform/scim/azure",
|
|
"documentation/platform/scim/jumpcloud"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Self-host Infisical",
|
|
"pages": [
|
|
"self-hosting/overview",
|
|
{
|
|
"group": "Installation methods",
|
|
"pages": [
|
|
"self-hosting/deployment-options/standalone-infisical",
|
|
"self-hosting/deployment-options/docker-swarm",
|
|
"self-hosting/deployment-options/docker-compose",
|
|
"self-hosting/deployment-options/kubernetes-helm"
|
|
]
|
|
},
|
|
"self-hosting/configuration/envars",
|
|
"self-hosting/configuration/requirements",
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
"self-hosting/configuration/schema-migrations",
|
|
"self-hosting/guides/mongo-to-postgres"
|
|
]
|
|
},
|
|
{
|
|
"group": "Reference architectures",
|
|
"pages": ["self-hosting/reference-architectures/aws-ecs"]
|
|
},
|
|
"self-hosting/ee",
|
|
"self-hosting/faq"
|
|
]
|
|
},
|
|
{
|
|
"group": "Command line",
|
|
"pages": [
|
|
"cli/overview",
|
|
"cli/usage",
|
|
{
|
|
"group": "Core commands",
|
|
"pages": [
|
|
"cli/commands/login",
|
|
"cli/commands/init",
|
|
"cli/commands/run",
|
|
"cli/commands/secrets",
|
|
"cli/commands/export",
|
|
"cli/commands/token",
|
|
"cli/commands/service-token",
|
|
"cli/commands/vault",
|
|
"cli/commands/user",
|
|
"cli/commands/reset",
|
|
{
|
|
"group": "infisical scan",
|
|
"pages": [
|
|
"cli/commands/scan",
|
|
"cli/commands/scan-git-changes",
|
|
"cli/commands/scan-install"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"cli/scanning-overview",
|
|
"cli/project-config",
|
|
"cli/faq"
|
|
]
|
|
},
|
|
{
|
|
"group": "Infrastructure Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "Container orchestrators",
|
|
"pages": [
|
|
"integrations/platforms/kubernetes",
|
|
"integrations/platforms/docker-swarm-with-agent",
|
|
"integrations/platforms/ecs-with-agent"
|
|
]
|
|
},
|
|
"integrations/platforms/infisical-agent",
|
|
{
|
|
"group": "Docker",
|
|
"pages": [
|
|
"integrations/platforms/docker-intro",
|
|
"integrations/platforms/docker",
|
|
"integrations/platforms/docker-pass-envs",
|
|
"integrations/platforms/docker-compose"
|
|
]
|
|
},
|
|
"integrations/frameworks/terraform",
|
|
"integrations/platforms/ansible"
|
|
]
|
|
},
|
|
{
|
|
"group": "Native Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "AWS",
|
|
"pages": [
|
|
"integrations/cloud/aws-parameter-store",
|
|
"integrations/cloud/aws-secret-manager",
|
|
"integrations/cloud/aws-amplify"
|
|
]
|
|
},
|
|
"integrations/cloud/vercel",
|
|
"integrations/cloud/azure-key-vault",
|
|
"integrations/cloud/gcp-secret-manager",
|
|
{
|
|
"group": "Cloudflare",
|
|
"pages": [
|
|
"integrations/cloud/cloudflare-pages",
|
|
"integrations/cloud/cloudflare-workers"
|
|
]
|
|
},
|
|
"integrations/cloud/heroku",
|
|
"integrations/cloud/render",
|
|
{
|
|
"group": "View more",
|
|
"pages": [
|
|
"integrations/cloud/digital-ocean-app-platform",
|
|
"integrations/cloud/netlify",
|
|
"integrations/cloud/railway",
|
|
"integrations/cloud/flyio",
|
|
"integrations/cloud/laravel-forge",
|
|
"integrations/cloud/supabase",
|
|
"integrations/cloud/northflank",
|
|
"integrations/cloud/hasura-cloud",
|
|
"integrations/cloud/terraform-cloud",
|
|
"integrations/cloud/qovery",
|
|
"integrations/cloud/hashicorp-vault",
|
|
"integrations/cloud/cloud-66",
|
|
"integrations/cloud/windmill"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "CI/CD Integrations",
|
|
"pages": [
|
|
"integrations/cicd/jenkins",
|
|
"integrations/cicd/githubactions",
|
|
"integrations/cicd/gitlab",
|
|
"integrations/cicd/bitbucket",
|
|
"integrations/cloud/teamcity",
|
|
{
|
|
"group": "View more",
|
|
"pages": [
|
|
"integrations/cicd/circleci",
|
|
"integrations/cicd/travisci",
|
|
"integrations/cicd/rundeck",
|
|
"integrations/cicd/codefresh",
|
|
"integrations/cloud/checkly"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Framework Integrations",
|
|
"pages": [
|
|
"integrations/frameworks/spring-boot-maven",
|
|
"integrations/frameworks/react",
|
|
"integrations/frameworks/vue",
|
|
"integrations/frameworks/express",
|
|
{
|
|
"group": "View more",
|
|
"pages": [
|
|
"integrations/frameworks/nextjs",
|
|
"integrations/frameworks/nestjs",
|
|
"integrations/frameworks/sveltekit",
|
|
"integrations/frameworks/nuxt",
|
|
"integrations/frameworks/gatsby",
|
|
"integrations/frameworks/remix",
|
|
"integrations/frameworks/vite",
|
|
"integrations/frameworks/fiber",
|
|
"integrations/frameworks/django",
|
|
"integrations/frameworks/flask",
|
|
"integrations/frameworks/laravel",
|
|
"integrations/frameworks/rails",
|
|
"integrations/frameworks/dotnet",
|
|
"integrations/platforms/pm2"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Build Tool Integrations",
|
|
"pages": ["integrations/build-tools/gradle"]
|
|
},
|
|
{
|
|
"group": "",
|
|
"pages": ["sdks/overview"]
|
|
},
|
|
{
|
|
"group": "SDK's",
|
|
"pages": [
|
|
"sdks/languages/node",
|
|
"sdks/languages/python",
|
|
"sdks/languages/go",
|
|
"sdks/languages/java",
|
|
"sdks/languages/csharp"
|
|
]
|
|
},
|
|
{
|
|
"group": "Overview",
|
|
"pages": [
|
|
"api-reference/overview/introduction",
|
|
"api-reference/overview/authentication",
|
|
{
|
|
"group": "Examples",
|
|
"pages": ["api-reference/overview/examples/integration"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Endpoints",
|
|
"pages": [
|
|
{
|
|
"group": "Identities",
|
|
"pages": [
|
|
"api-reference/endpoints/identities/create",
|
|
"api-reference/endpoints/identities/update",
|
|
"api-reference/endpoints/identities/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Universal Auth",
|
|
"pages": [
|
|
"api-reference/endpoints/universal-auth/login",
|
|
"api-reference/endpoints/universal-auth/attach",
|
|
"api-reference/endpoints/universal-auth/retrieve",
|
|
"api-reference/endpoints/universal-auth/update",
|
|
"api-reference/endpoints/universal-auth/create-client-secret",
|
|
"api-reference/endpoints/universal-auth/list-client-secrets",
|
|
"api-reference/endpoints/universal-auth/revoke-client-secret",
|
|
"api-reference/endpoints/universal-auth/renew-access-token",
|
|
"api-reference/endpoints/universal-auth/revoke-access-token"
|
|
]
|
|
},
|
|
{
|
|
"group": "Organizations",
|
|
"pages": [
|
|
"api-reference/endpoints/organizations/memberships",
|
|
"api-reference/endpoints/organizations/update-membership",
|
|
"api-reference/endpoints/organizations/delete-membership",
|
|
"api-reference/endpoints/organizations/list-identity-memberships",
|
|
"api-reference/endpoints/organizations/workspaces"
|
|
]
|
|
},
|
|
{
|
|
"group": "Projects",
|
|
"pages": [
|
|
"api-reference/endpoints/workspaces/create-workspace",
|
|
"api-reference/endpoints/workspaces/delete-workspace",
|
|
"api-reference/endpoints/workspaces/get-workspace",
|
|
"api-reference/endpoints/workspaces/update-workspace",
|
|
"api-reference/endpoints/workspaces/secret-snapshots",
|
|
"api-reference/endpoints/workspaces/rollback-snapshot"
|
|
]
|
|
},
|
|
{
|
|
"group": "Project Users",
|
|
"pages": [
|
|
"api-reference/endpoints/project-users/invite-member-to-workspace",
|
|
"api-reference/endpoints/project-users/remove-member-from-workspace",
|
|
"api-reference/endpoints/project-users/memberships",
|
|
"api-reference/endpoints/project-users/get-by-username",
|
|
"api-reference/endpoints/project-users/update-membership"
|
|
]
|
|
},
|
|
{
|
|
"group": "Project Identities",
|
|
"pages": [
|
|
"api-reference/endpoints/project-identities/add-identity-membership",
|
|
"api-reference/endpoints/project-identities/list-identity-memberships",
|
|
"api-reference/endpoints/project-identities/get-by-id",
|
|
"api-reference/endpoints/project-identities/update-identity-membership",
|
|
"api-reference/endpoints/project-identities/delete-identity-membership"
|
|
]
|
|
},
|
|
{
|
|
"group": "Project Roles",
|
|
"pages": [
|
|
"api-reference/endpoints/project-roles/create",
|
|
"api-reference/endpoints/project-roles/update",
|
|
"api-reference/endpoints/project-roles/delete",
|
|
"api-reference/endpoints/project-roles/get-by-slug",
|
|
"api-reference/endpoints/project-roles/list"
|
|
]
|
|
},
|
|
{
|
|
"group": "Environments",
|
|
"pages": [
|
|
"api-reference/endpoints/environments/create",
|
|
"api-reference/endpoints/environments/update",
|
|
"api-reference/endpoints/environments/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Folders",
|
|
"pages": [
|
|
"api-reference/endpoints/folders/list",
|
|
"api-reference/endpoints/folders/create",
|
|
"api-reference/endpoints/folders/update",
|
|
"api-reference/endpoints/folders/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Secret Tags",
|
|
"pages": [
|
|
"api-reference/endpoints/secret-tags/list",
|
|
"api-reference/endpoints/secret-tags/get-by-id",
|
|
"api-reference/endpoints/secret-tags/get-by-slug",
|
|
"api-reference/endpoints/secret-tags/create",
|
|
"api-reference/endpoints/secret-tags/update",
|
|
"api-reference/endpoints/secret-tags/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Secrets",
|
|
"pages": [
|
|
"api-reference/endpoints/secrets/list",
|
|
"api-reference/endpoints/secrets/create",
|
|
"api-reference/endpoints/secrets/read",
|
|
"api-reference/endpoints/secrets/update",
|
|
"api-reference/endpoints/secrets/delete",
|
|
"api-reference/endpoints/secrets/create-many",
|
|
"api-reference/endpoints/secrets/update-many",
|
|
"api-reference/endpoints/secrets/delete-many",
|
|
"api-reference/endpoints/secrets/attach-tags",
|
|
"api-reference/endpoints/secrets/detach-tags"
|
|
]
|
|
},
|
|
{
|
|
"group": "Secret Imports",
|
|
"pages": [
|
|
"api-reference/endpoints/secret-imports/list",
|
|
"api-reference/endpoints/secret-imports/create",
|
|
"api-reference/endpoints/secret-imports/update",
|
|
"api-reference/endpoints/secret-imports/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Identity Specific Privilege",
|
|
"pages": [
|
|
"api-reference/endpoints/identity-specific-privilege/create-permanent",
|
|
"api-reference/endpoints/identity-specific-privilege/create-temporary",
|
|
"api-reference/endpoints/identity-specific-privilege/update",
|
|
"api-reference/endpoints/identity-specific-privilege/delete",
|
|
"api-reference/endpoints/identity-specific-privilege/find-by-slug",
|
|
"api-reference/endpoints/identity-specific-privilege/list"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
"api-reference/endpoints/integrations/create-auth",
|
|
"api-reference/endpoints/integrations/list-auth",
|
|
"api-reference/endpoints/integrations/find-auth",
|
|
"api-reference/endpoints/integrations/delete-auth",
|
|
"api-reference/endpoints/integrations/delete-auth-by-id",
|
|
"api-reference/endpoints/integrations/create",
|
|
"api-reference/endpoints/integrations/update",
|
|
"api-reference/endpoints/integrations/delete",
|
|
"api-reference/endpoints/integrations/list-project-integrations"
|
|
]
|
|
},
|
|
{
|
|
"group": "Service Tokens",
|
|
"pages": ["api-reference/endpoints/service-tokens/get"]
|
|
},
|
|
{
|
|
"group": "Audit Logs",
|
|
"pages": ["api-reference/endpoints/audit-logs/export-audit-log"]
|
|
},
|
|
{
|
|
"group": "Certificate Authorities",
|
|
"pages": [
|
|
"api-reference/endpoints/certificate-authorities/create",
|
|
"api-reference/endpoints/certificate-authorities/read",
|
|
"api-reference/endpoints/certificate-authorities/update",
|
|
"api-reference/endpoints/certificate-authorities/delete",
|
|
"api-reference/endpoints/certificate-authorities/csr",
|
|
"api-reference/endpoints/certificate-authorities/cert",
|
|
"api-reference/endpoints/certificate-authorities/sign-intermediate",
|
|
"api-reference/endpoints/certificate-authorities/import-cert",
|
|
"api-reference/endpoints/certificate-authorities/issue-cert",
|
|
"api-reference/endpoints/certificate-authorities/crl"
|
|
]
|
|
},
|
|
{
|
|
"group": "Certificates",
|
|
"pages": [
|
|
"api-reference/endpoints/certificates/read",
|
|
"api-reference/endpoints/certificates/revoke",
|
|
"api-reference/endpoints/certificates/delete",
|
|
"api-reference/endpoints/certificates/cert-body"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Internals",
|
|
"pages": [
|
|
"internals/overview",
|
|
"internals/components",
|
|
"internals/flows",
|
|
"internals/security",
|
|
"internals/service-tokens"
|
|
]
|
|
},
|
|
{
|
|
"group": "",
|
|
"pages": ["changelog/overview"]
|
|
},
|
|
{
|
|
"group": "Contributing",
|
|
"pages": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"contributing/getting-started/overview",
|
|
"contributing/getting-started/code-of-conduct",
|
|
"contributing/getting-started/pull-requests",
|
|
"contributing/getting-started/faq"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contributing to platform",
|
|
"pages": [
|
|
"contributing/platform/developing",
|
|
"contributing/platform/backend/how-to-create-a-feature",
|
|
"contributing/platform/backend/folder-structure"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contributing to SDK",
|
|
"pages": ["contributing/sdk/developing"]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"integrations": {
|
|
"intercom": "hsg644ru"
|
|
}
|
|
}
|