diff --git a/docs/api-reference/endpoints/integrations/create-auth.mdx b/docs/api-reference/endpoints/integrations/create-auth.mdx new file mode 100644 index 000000000..3bec1bddc --- /dev/null +++ b/docs/api-reference/endpoints/integrations/create-auth.mdx @@ -0,0 +1,30 @@ +--- +title: "Create Auth" +openapi: "POST /api/v1/integration-auth/access-token" +--- + +## Integration Auth Parameters + +We have a generic endpoints for creating integration auth objects. These are the parameters required for each integration. +<Tabs> + <Tab title="AWS Secrets manager"> + <ParamField body="integration" type="string" initialValue="aws-secret-manager" required> + This value must be **aws-secret-manager**. + </ParamField> + <ParamField body="workspaceId" type="string" required> + Infisical project id for the integration. + </ParamField> + <ParamField body="accessId" type="string" required> + The AWS IAM User Access ID. + </ParamField> + <ParamField body="accessToken" type="string" required> + The AWS IAM User Access Secret Key. + </ParamField> + </Tab> + <Tab title="GCP Secrets manager"> + Coming Soon + </Tab> + <Tab title="Heroku"> + Coming Soon + </Tab> +</Tabs> diff --git a/docs/api-reference/endpoints/integrations/create.mdx b/docs/api-reference/endpoints/integrations/create.mdx new file mode 100644 index 000000000..0572895cf --- /dev/null +++ b/docs/api-reference/endpoints/integrations/create.mdx @@ -0,0 +1,39 @@ +--- +title: "Create" +openapi: "POST /api/v1/integration" +--- + +## Integration Parameters + +We have a generic endpoints for creating integration. These are the parameters required for each integration. + +<Tabs> + <Tab title="AWS Secrets manager"> + <ParamField body="integrationAuthId" type="string" required> + The ID of the integration auth object for authentication with AWS. + Refer [Create Integration Auth](./create-auth) for more info + </ParamField> + <ParamField body="isActive" type="boolean"> + Whether the integration should be active or inactive + </ParamField> + <ParamField body="app" type="string" required> + The secret name used when saving secret in AWS SSM. + </ParamField> + <ParamField body="region" type="string" required> + The AWS region of the SSM. + </ParamField> + <ParamField body="sourceEnvironment" type="string" required> + The infisical environment for the secrets to be synced. + </ParamField> + <ParamField body="secretPath" type="string" required> + The infisical secret path for the secrets to be synced. + </ParamField> + </Tab> + <Tab title="GCP Secrets manager"> + Coming Soon + </Tab> + <Tab title="Heroku"> + Coming Soon + </Tab> +</Tabs> + diff --git a/docs/api-reference/endpoints/integrations/delete-auth-by-id.mdx b/docs/api-reference/endpoints/integrations/delete-auth-by-id.mdx new file mode 100644 index 000000000..5884363fc --- /dev/null +++ b/docs/api-reference/endpoints/integrations/delete-auth-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete Auth By ID" +openapi: "DELETE /api/v1/integration-auth/{integrationAuthId}" +--- diff --git a/docs/api-reference/endpoints/integrations/delete-auth.mdx b/docs/api-reference/endpoints/integrations/delete-auth.mdx new file mode 100644 index 000000000..93d957903 --- /dev/null +++ b/docs/api-reference/endpoints/integrations/delete-auth.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete Auth" +openapi: "DELETE /api/v1/integration-auth" +--- diff --git a/docs/api-reference/endpoints/integrations/delete.mdx b/docs/api-reference/endpoints/integrations/delete.mdx new file mode 100644 index 000000000..51df56de7 --- /dev/null +++ b/docs/api-reference/endpoints/integrations/delete.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete" +openapi: "DELETE /api/v1/integration/{integrationId}" +--- diff --git a/docs/api-reference/endpoints/integrations/find-auth.mdx b/docs/api-reference/endpoints/integrations/find-auth.mdx new file mode 100644 index 000000000..439b82935 --- /dev/null +++ b/docs/api-reference/endpoints/integrations/find-auth.mdx @@ -0,0 +1,4 @@ +--- +title: "Get Auth By ID" +openapi: "GET /api/v1/integration-auth/{integrationAuthId}" +--- diff --git a/docs/api-reference/endpoints/integrations/list-auth.mdx b/docs/api-reference/endpoints/integrations/list-auth.mdx new file mode 100644 index 000000000..3ca961d98 --- /dev/null +++ b/docs/api-reference/endpoints/integrations/list-auth.mdx @@ -0,0 +1,4 @@ +--- +title: "List Auth" +openapi: "GET /api/v1/workspace/{workspaceId}/authorizations" +--- diff --git a/docs/api-reference/endpoints/integrations/update.mdx b/docs/api-reference/endpoints/integrations/update.mdx new file mode 100644 index 000000000..8567c46ae --- /dev/null +++ b/docs/api-reference/endpoints/integrations/update.mdx @@ -0,0 +1,4 @@ +--- +title: "Update" +openapi: "PATCH /api/v1/integration/{integrationId}" +--- diff --git a/docs/mint.json b/docs/mint.json index 9d9759f0e..4f70fb4c4 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -1,6 +1,6 @@ { "name": "Infisical", - "openapi": "https://app.infisical.com/api/docs/json", + "openapi": "http://localhost:8080/api/docs/json", "logo": { "dark": "/logo/dark.svg", "light": "/logo/light.svg", @@ -32,7 +32,10 @@ "thumbsRating": true }, "api": { - "baseUrl": ["https://app.infisical.com", "http://localhost:8080"] + "baseUrl": [ + "https://app.infisical.com", + "http://localhost:8080" + ] }, "topbarLinks": [ { @@ -279,7 +282,7 @@ "integrations/cloud/azure-key-vault", "integrations/cloud/gcp-secret-manager", { - "group": "Cloudflare", + "group": "Cloudflare", "pages": [ "integrations/cloud/cloudflare-pages", "integrations/cloud/cloudflare-workers" @@ -356,14 +359,16 @@ }, { "group": "Build Tool Integrations", - "pages": ["integrations/build-tools/gradle"] + "pages": [ + "integrations/build-tools/gradle" + ] }, { "group": "", "pages": [ "sdks/overview" ] - }, + }, { "group": "SDK's", "pages": [ @@ -494,13 +499,30 @@ "api-reference/endpoints/secret-imports/delete" ] }, + { + "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" + ] + }, { "group": "Service Tokens", - "pages": ["api-reference/endpoints/service-tokens/get"] + "pages": [ + "api-reference/endpoints/service-tokens/get" + ] }, { "group": "Audit Logs", - "pages": ["api-reference/endpoints/audit-logs/export-audit-log"] + "pages": [ + "api-reference/endpoints/audit-logs/export-audit-log" + ] } ] }, @@ -516,21 +538,22 @@ }, { "group": "", - "pages": ["changelog/overview"] + "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": "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": [ @@ -540,11 +563,11 @@ ] }, { - "group": "Contributing to SDK", - "pages": [ - "contributing/sdk/developing" - ] - } + "group": "Contributing to SDK", + "pages": [ + "contributing/sdk/developing" + ] + } ] } ],