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

rebase

Browse Source
This commit is contained in:
Scott Wilson
2025-04-11 12:25:26 -07:00
parent 27fdf68e42
commit 581e4b35f9
120 changed files with 1963 additions and 423 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-reference/endpoints/app-connections/auth0/available.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Available"
openapi: "GET /api/v1/app-connections/auth0/available"
---

9
docs/api-reference/endpoints/app-connections/auth0/create.mdx Normal file
View File

@@ -0,0 +1,9 @@
---
title: "Create"
openapi: "POST /api/v1/app-connections/auth0"
---
<Note>
Check out the configuration docs for [Auth0 Connections](/integrations/app-connections/auth0) to learn how to obtain the
required credentials.
</Note>

4
docs/api-reference/endpoints/app-connections/auth0/delete.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/app-connections/auth0/{connectionId}"
---

4
docs/api-reference/endpoints/app-connections/auth0/get-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/app-connections/auth0/{connectionId}"
---

4
docs/api-reference/endpoints/app-connections/auth0/get-by-name.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by Name"
openapi: "GET /api/v1/app-connections/auth0/connection-name/{connectionName}"
---

4
docs/api-reference/endpoints/app-connections/auth0/list.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/app-connections/auth0"
---

9
docs/api-reference/endpoints/app-connections/auth0/update.mdx Normal file
View File

@@ -0,0 +1,9 @@
---
title: "Update"
openapi: "PATCH /api/v1/app-connections/auth0/{connectionId}"
---
<Note>
Check out the configuration docs for [Auth0 Connections](/integrations/app-connections/auth0) to learn how to obtain the
required credentials.
</Note>

9
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/create.mdx Normal file
View File

@@ -0,0 +1,9 @@
---
title: "Create"
openapi: "POST /api/v2/secret-rotations/auth0-client-secret"
---
<Note>
Check out the configuration docs for [Auth0 Client Secret Rotations](/documentation/platform/secret-rotation/auth0-client-secret) to learn how to obtain the
required parameters.
</Note>

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/delete.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v2/secret-rotations/auth0-client-secret/{rotationId}"
---

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/get-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v2/secret-rotations/auth0-client-secret/{rotationId}"
---

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/get-by-name.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by Name"
openapi: "GET /api/v2/secret-rotations/auth0-client-secret/rotation-name/{rotationName}"
---

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/get-generated-credentials-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get Credentials by ID"
openapi: "GET /api/v2/secret-rotations/auth0-client-secret/{rotationId}/generated-credentials"
---

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/list.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v2/secret-rotations/auth0-client-secret"
---

4
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/rotate-secrets.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Rotate Secrets"
openapi: "POST /api/v2/secret-rotations/auth0-client-secret/{rotationId}/rotate-secrets"
---

9
docs/api-reference/endpoints/secret-rotations/auth0-client-secret/update.mdx Normal file
View File

@@ -0,0 +1,9 @@
---
title: "Update"
openapi: "PATCH /api/v2/secret-rotations/auth0-client-secret/{rotationId}"
---
<Note>
Check out the configuration docs for [Auth0 Client Secret Rotations](/documentation/platform/secret-rotation/auth0-client-secret) to learn how to obtain the
required parameters.
</Note>

2
docs/api-reference/endpoints/secret-rotations/mssql-credentials/create.mdx
View File

@@ -5,6 +5,6 @@ openapi: "POST /api/v2/secret-rotations/mssql-credentials"
<Note>
Check out the configuration docs for [Microsoft SQL Server
Credentials Rotations](/documentation/platform/secret-rotation/mssql) to learn how to obtain the
Credentials Rotations](/documentation/platform/secret-rotation/mssql-credentials) to learn how to obtain the
required parameters.
</Note>

2
docs/api-reference/endpoints/secret-rotations/mssql-credentials/update.mdx
View File

@@ -5,6 +5,6 @@ openapi: "PATCH /api/v2/secret-rotations/mssql-credentials/{rotationId}"
<Note>
Check out the configuration docs for [Microsoft SQL Server
Credentials Rotations](/documentation/platform/secret-rotation/mssql) to learn how to obtain the
Credentials Rotations](/documentation/platform/secret-rotation/mssql-credentials) to learn how to obtain the
required parameters.
</Note>

2
docs/api-reference/endpoints/secret-rotations/postgres-credentials/create.mdx
View File

@@ -5,6 +5,6 @@ openapi: "POST /api/v2/secret-rotations/postgres-credentials"
<Note>
Check out the configuration docs for [PostgreSQL
Credentials Rotations](/documentation/platform/secret-rotation/postgres) to learn how to obtain the
Credentials Rotations](/documentation/platform/secret-rotation/postgres-credentials) to learn how to obtain the
required parameters.
</Note>

2
docs/api-reference/endpoints/secret-rotations/postgres-credentials/update.mdx
View File

@@ -5,6 +5,6 @@ openapi: "PATCH /api/v2/secret-rotations/postgres-credentials/{rotationId}"
<Note>
Check out the configuration docs for [PostgreSQL
Credentials Rotations](/documentation/platform/secret-rotation/postgres) to learn how to obtain the
Credentials Rotations](/documentation/platform/secret-rotation/postgres-credentials) to learn how to obtain the
required parameters.
</Note>

2
docs/changelog/overview.mdx
View File

@@ -173,7 +173,7 @@ The changelog below reflects new product developments and updates on a monthly b
- Replaced internal [Winston](https://github.com/winstonjs/winston) with [Pino](https://github.com/pinojs/pino) logging library with external logging to AWS CloudWatch
- Added admin panel to self-hosting experience.
- Released [secret rotation](https://infisical.com/docs/documentation/platform/secret-rotation/overview) feature with preliminary support for rotating [SendGrid](https://infisical.com/docs/documentation/platform/secret-rotation/sendgrid), [PostgreSQL/CockroachDB](https://infisical.com/docs/documentation/platform/secret-rotation/postgres), and [MySQL/MariaDB](https://infisical.com/docs/documentation/platform/secret-rotation/mysql) credentials.
- Released [secret rotation](https://infisical.com/docs/documentation/platform/secret-rotation/overview) feature with preliminary support for rotating [SendGrid](https://infisical.com/docs/documentation/platform/secret-rotation/sendgrid), [PostgreSQL/CockroachDB](https://infisical.com/docs/documentation/platform/secret-rotation/postgres-credentials), and [MySQL/MariaDB](https://infisical.com/docs/documentation/platform/secret-rotation/mysql) credentials.
- Released secret reminders feature.
## Oct 2023

148
docs/documentation/platform/secret-rotation/auth0-client-secret.mdx Normal file
View File

@@ -0,0 +1,148 @@
---
title: "Auth0 Client Secret"
description: "Learn how to automatically rotate Auth0 Client Secrets."
---
<Note>
Due to how Auth0 client secrets are rotated, retired credentials will not be able to
authenticate with Auth0 during their [inactive period](./overview#how-rotation-works).
This is a limitation of the Auth0 platform and cannot be
rectified by Infisical.
</Note>
## Prerequisites
1. Create an [Auth0 Connection](/integrations/app-connections/auth0) with the required **Secret Rotation** audience and permissions
2. Copy the **Client ID** of the application in Auth0 you want to rotate the Client Secret for:
![Auth0 Client ID](/images/secret-rotations-v2/auth0-client-secret/auth0-app-client-id.png)
## Create an Auth0 Client Secret Rotation in Infisical
<Tabs>
<Tab title="Infisical UI">
1. Navigate to your Secret Manager Project's Dashboard and select **Add Secret Rotation** from the actions dropdown.
![Secret Manager Dashboard](/images/secret-rotations-v2/generic/add-secret-rotation.png)
2. Select the **Auth0 Client Secret** option.
![Select Auth0 Client Secret](/images/secret-rotations-v2/auth0-client-secret/select-auth0-client-secret-option.png)
3. Select the **Auth0 Connection** to use and configure the rotation behavior. Then click **Next**.
![Rotation Configuration](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-configuration.png)
- **Auth0 Connection** - the connection that will perform the rotation of the specified application's Client Secret.
- **Rotation Interval** - the interval, in days, that once elapsed will trigger a rotation.
- **Rotate At** - the local time of day when rotation should occur once the interval has elapsed.
- **Auto-Rotation Enabled** - whether secrets should automatically be rotated once the rotation interval has elapsed. Disable this option to manually rotate secrets or pause secret rotation.
4. Input the Client ID of the Auth0 application acquired above that will have its Client Secret rotated. Then click **Next**.
![Rotation Parameters](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-parameters.png)
- **Client ID** - the Client ID of the application whose Client Secret will be rotated.
5. Specify the secret names that the client credentials should be mapped to. Then click **Next**.
![Rotation Secrets Mapping](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-secrets-mapping.png)
- **Client ID** - the name of the secret that the application Client ID will be mapped to.
- **Client Secret** - the name of the secret that the rotated Client Secret will be mapped to.
6. Give your rotation a name and description (optional). Then click **Next**.
![Rotation Details](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-details.png)
- **Name** - the name of the secret rotation configuration. Must be slug-friendly.
- **Description** (optional) - a description of this rotation configuration.
7. Review your configuration, then click **Create Secret Rotation**.
![Rotation Review](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-confirm.png)
8. Your **Auth0 Client Secret** credentials are now available for use via the mapped secrets.
![Rotation Created](/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-created.png)
</Tab>
<Tab title="API">
To create an Auth0 Client Secret Rotation, make an API request to the [Create Auth0
Client Secret Rotation](/api-reference/endpoints/secret-rotations/auth0-client-secret/create) API endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://us.infisical.com/api/v2/secret-rotations/auth0-client-secret \
--header 'Content-Type: application/json' \
--data '{
"name": "my-pg-rotation",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "my database credentials rotation",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "dev",
"secretPath": "/",
"isAutoRotationEnabled": true,
"rotationInterval": 30,
"rotateAtUtc": {
"hours": 0,
"minutes": 0
},
"parameters": {
"clientId": "...",
},
"secretsMapping": {
"clientId": "AUTH0_CLIENT_ID",
"clientSecret": "AUTH0_CLIENT_SECRET"
}
}'
```
### Sample response
```bash Response
{
"secretRotation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "my-pg-rotation",
"description": "my database credentials rotation",
"secretsMapping": {
"clientId": "AUTH0_CLIENT_ID",
"clientSecret": "AUTH0_CLIENT_SECRET"
},
"isAutoRotationEnabled": true,
"activeIndex": 0,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"rotationInterval": 30,
"rotationStatus": "success",
"lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
"lastRotatedAt": "2023-11-07T05:31:56Z",
"lastRotationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nextRotationAt": "2023-11-07T05:31:56Z",
"connection": {
"app": "auth0",
"name": "my-auth0-connection",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"slug": "dev",
"name": "Development",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "/"
},
"rotateAtUtc": {
"hours": 0,
"minutes": 0
},
"lastRotationMessage": null,
"type": "auth0-client-secret",
"parameters": {
"clientId": "...",
}
}
}
```
</Tab>
</Tabs>

0
docs/documentation/platform/secret-rotation/mssql.mdx → docs/documentation/platform/secret-rotation/mssql-credentials.mdx
View File

0
docs/documentation/platform/secret-rotation/postgres.mdx → docs/documentation/platform/secret-rotation/postgres-credentials.mdx
View File

BIN
docs/images/app-connections/auth0/auth0-audience.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 370 KiB

BIN
docs/images/app-connections/auth0/auth0-client-credentials.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 445 KiB

BIN
docs/images/app-connections/auth0/auth0-dashboard-applications.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 373 KiB

BIN
docs/images/app-connections/auth0/auth0-secret-rotation-api-selection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 371 KiB

BIN
docs/images/app-connections/auth0/auth0-select-m2m.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 420 KiB

BIN
docs/images/app-connections/auth0/client-credentials-create.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 781 KiB

BIN
docs/images/app-connections/auth0/client_credentials_connection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 MiB

BIN
docs/images/app-connections/auth0/select-auth0-connection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 784 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-app-client-id.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 343 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-configuration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 750 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-confirm.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 759 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-created.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 MiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-details.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 687 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-parameters.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 712 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/auth0-client-secret-secrets-mapping.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 723 KiB

BIN
docs/images/secret-rotations-v2/auth0-client-secret/select-auth0-client-secret-option.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 695 KiB

101
docs/integrations/app-connections/auth0.mdx Normal file
View File

@@ -0,0 +1,101 @@
---
title: "Auth0 Connection"
description: "Learn how to configure a Auth0 Connection for Infisical."
---
Infisical supports the use of [Client Credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) to connect with your Auth0 applications.
## Configure a Machine-to-Machine Application in Auth0
<Steps>
<Step title="Auth0 Applications Dashboard">
Navigate to the **Applications** page in Auth0 via the sidebar and click **Create Application**.
![Applications Page](/images/app-connections/auth0/auth0-dashboard-applications.png)
</Step>
<Step title="Create a Machine-to-Machine Application">
Give your application a name and select **Machine-to-Machine** for the application type.
![Create Machine-to-Machine Application](/images/app-connections/auth0/auth0-select-m2m.png)
</Step>
<Step title="Configure Authorization">
Depending on your connection use case, authorize your application for the applicable API and grant the relevant permissions. Once done, click **Authorize**.
<Tabs>
<Tab title="Secret Rotation">
Select the **Auth0 Management API** option from the dropdown and grant the `update:client_keys` permission.
![Secret Rotation Authorization](/images/app-connections/auth0/auth0-secret-rotation-api-selection.png)
</Tab>
</Tabs>
</Step>
<Step title="Application Client Credentials">
On your application page, select the **Settings** tab and copy the **Domain**, **Client ID** and **Client Secret** for later.
![Client Credentials](/images/app-connections/auth0/auth0-client-credentials.png)
</Step>
<Step title="Application Audience">
Next, select the **APIs** tab and copy the **API Identifier**.
![Application Audience](/images/app-connections/auth0/auth0-audience.png)
</Step>
</Steps>
## Setup Auth0 Connection in Infisical
<Tabs>
<Tab title="Infisical UI">
1. Navigate to the App Connections tab on the Organization Settings page.
![App Connections Tab](/images/app-connections/general/add-connection.png)
2. Select the **Auth0 Connection** option.
![Select Auth0 Connection](/images/app-connections/auth0/select-auth0-connection.png)
3. Select the **Client Credentials** method option and provide the details obtained from the previous section and press **Connect to Auth0**.
![Create Auth0 Connection](/images/app-connections/auth0/client-credentials-create.png)
4. Your **Auth0 Connection** is now available for use.
![Assume Role Auth0 Connection](/images/app-connections/auth0/client_credentials_connection.png)
</Tab>
<Tab title="API">
To create a Auth0 Connection, make an API request to the [Create Auth0
Connection](/api-reference/endpoints/app-connections/auth0/create) API endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://app.infisical.com/api/v1/app-connections/auth0 \
--header 'Content-Type: application/json' \
--data '{
"name": "my-auth0-connection",
"method": "client-credentials",
"credentials": {
"domain": "xxx-xxxxxxxxx.us.auth0.com",
"clientId": "...",
"clientSecret": "...",
"audience": "https://xxx-xxxxxxxxx.us.auth0.com/api/v2/"
},
}'
```
### Sample response
```bash Response
{
"appConnection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "my-auth0-connection",
"version": 1,
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"app": "auth0",
"method": "client-credentials",
"credentials": {
"domain": "xxx-xxxxxxxxx.us.auth0.com",
"clientId": "...",
"audience": "https://xxx-xxxxxxxxx.us.auth0.com/api/v2/"
}
}
}
```
</Tab>
</Tabs>

31
docs/mint.json
View File

@@ -178,8 +178,9 @@
"group": "Secret Rotation",
"pages": [
"documentation/platform/secret-rotation/overview",
"documentation/platform/secret-rotation/postgres",
"documentation/platform/secret-rotation/mssql"
"documentation/platform/secret-rotation/auth0-client-secret",
"documentation/platform/secret-rotation/postgres-credentials",
"documentation/platform/secret-rotation/mssql-credentials"
]
},
{
@@ -414,6 +415,7 @@
{
"group": "Connections",
"pages": [
"integrations/app-connections/auth0",
"integrations/app-connections/aws",
"integrations/app-connections/azure-app-configuration",
"integrations/app-connections/azure-key-vault",
@@ -836,6 +838,19 @@
"pages": [
"api-reference/endpoints/secret-rotations/list",
"api-reference/endpoints/secret-rotations/options",
{
"group": "Auth0 Client Secret",
"pages": [
"api-reference/endpoints/secret-rotations/auth0-client-secret/create",
"api-reference/endpoints/secret-rotations/auth0-client-secret/delete",
"api-reference/endpoints/secret-rotations/auth0-client-secret/get-by-id",
"api-reference/endpoints/secret-rotations/auth0-client-secret/get-by-name",
"api-reference/endpoints/secret-rotations/auth0-client-secret/get-generated-credentials-by-id",
"api-reference/endpoints/secret-rotations/auth0-client-secret/list",
"api-reference/endpoints/secret-rotations/auth0-client-secret/rotate-secrets",
"api-reference/endpoints/secret-rotations/auth0-client-secret/update"
]
},
{
"group": "Microsoft SQL Server Credentials",
"pages": [
@@ -880,6 +895,18 @@
"pages": [
"api-reference/endpoints/app-connections/list",
"api-reference/endpoints/app-connections/options",
{
"group": "Auth0",
"pages": [
"api-reference/endpoints/app-connections/auth0/list",
"api-reference/endpoints/app-connections/auth0/available",
"api-reference/endpoints/app-connections/auth0/get-by-id",
"api-reference/endpoints/app-connections/auth0/get-by-name",
"api-reference/endpoints/app-connections/auth0/create",
"api-reference/endpoints/app-connections/auth0/update",
"api-reference/endpoints/app-connections/auth0/delete"
]
},
{
"group": "AWS",
"pages": [