awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(doc): added integration and integration auth to api reference doc

Browse Source
This commit is contained in:
Akhil Mohan
2024-04-02 16:30:53 +05:30
parent 094b48a2b1
commit 17995d301a
9 changed files with 139 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/api-reference/endpoints/integrations/create-auth.mdx Normal file
View File

@@ -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>

39
docs/api-reference/endpoints/integrations/create.mdx Normal file
View File

@@ -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>

4
docs/api-reference/endpoints/integrations/delete-auth-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete Auth By ID"
openapi: "DELETE /api/v1/integration-auth/{integrationAuthId}"
---

4
docs/api-reference/endpoints/integrations/delete-auth.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete Auth"
openapi: "DELETE /api/v1/integration-auth"
---

4
docs/api-reference/endpoints/integrations/delete.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/integration/{integrationId}"
---

4
docs/api-reference/endpoints/integrations/find-auth.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get Auth By ID"
openapi: "GET /api/v1/integration-auth/{integrationAuthId}"
---

4
docs/api-reference/endpoints/integrations/list-auth.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List Auth"
openapi: "GET /api/v1/workspace/{workspaceId}/authorizations"
---

4
docs/api-reference/endpoints/integrations/update.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/integration/{integrationId}"
---