Merge pull request #3857 from Infisical/daniel/fix-dotnet-docs

docs: fix redirect for .NET SDK
This commit is contained in:
Daniel Hougaard
2025-06-25 23:18:14 +04:00
committed by GitHub
4 changed files with 113 additions and 114 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: "Infisical Java SDK" title: "Infisical Java SDK"
sidebarTitle: "Java" sidebarTitle: "Java"
url: "https://github.com/Infisical/java-sdk?tab=readme-ov-file#infisical-nodejs-sdk" url: "https://github.com/Infisical/java-sdk?tab=readme-ov-file#infisical-java-sdk"
icon: "java" icon: "java"
--- ---
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: "Infisical Node.js SDK" title: "Infisical Node.js SDK"
sidebarTitle: "Node.js" sidebarTitle: "Node.js"
url: "https://github.com/Infisical/node-sdk-v2" url: "https://github.com/Infisical/node-sdk-v2?tab=readme-ov-file#infisical-nodejs-sdk"
icon: "node" icon: "node"
--- ---
+100 -100
View File
@@ -43,7 +43,7 @@ def hello_world():
This example demonstrates how to use the Infisical Python SDK with a Flask application. The application retrieves a secret named "NAME" and responds to requests with a greeting that includes the secret value. This example demonstrates how to use the Infisical Python SDK with a Flask application. The application retrieves a secret named "NAME" and responds to requests with a greeting that includes the secret value.
<Warning> <Warning>
We do not recommend hardcoding your [Machine Identity Tokens](/platform/identities/overview). Setting it as an environment variable would be best. We do not recommend hardcoding your [Machine Identity Tokens](/platform/identities/overview). Setting it as an environment variable would be best.
</Warning> </Warning>
## Installation ## Installation
@@ -314,32 +314,32 @@ By default, `getSecret()` fetches and returns a shared secret. If not found, it
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" optional> <ParamField query="Parameters" type="object" optional>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="secret_name" type="string" required> <ParamField query="secret_name" type="string" required>
The key of the secret to retrieve The key of the secret to retrieve
</ParamField> </ParamField>
<ParamField query="include_imports" type="boolean"> <ParamField query="include_imports" type="boolean">
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="environment" type="string" required> <ParamField query="environment" type="string" required>
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from. The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
</ParamField> </ParamField>
<ParamField query="project_id" type="string" required> <ParamField query="project_id" type="string" required>
The project ID where the secret lives in. The project ID where the secret lives in.
</ParamField> </ParamField>
<ParamField query="path" type="string" optional> <ParamField query="path" type="string" optional>
The path from where secret should be fetched from. The path from where secret should be fetched from.
</ParamField> </ParamField>
<ParamField query="type" type="string" optional> <ParamField query="type" type="string" optional>
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "personal". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "personal".
</ParamField> </ParamField>
<ParamField query="include_imports" type="boolean" default="false" optional> <ParamField query="include_imports" type="boolean" default="false" optional>
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="expand_secret_references" type="boolean" default="true" optional> <ParamField query="expand_secret_references" type="boolean" default="true" optional>
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference) Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
### client.createSecret(options) ### client.createSecret(options)
@@ -358,26 +358,26 @@ Create a new secret in Infisical.
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" optional> <ParamField query="Parameters" type="object" optional>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="secret_name" type="string" required> <ParamField query="secret_name" type="string" required>
The key of the secret to create. The key of the secret to create.
</ParamField> </ParamField>
<ParamField query="secret_value" type="string" required> <ParamField query="secret_value" type="string" required>
The value of the secret. The value of the secret.
</ParamField> </ParamField>
<ParamField query="project_id" type="string" required> <ParamField query="project_id" type="string" required>
The project ID where the secret lives in. The project ID where the secret lives in.
</ParamField> </ParamField>
<ParamField query="environment" type="string" required> <ParamField query="environment" type="string" required>
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from. The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
</ParamField> </ParamField>
<ParamField query="path" type="string" optional> <ParamField query="path" type="string" optional>
The path from where secret should be created. The path from where secret should be created.
</ParamField> </ParamField>
<ParamField query="type" type="string" optional> <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". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
### client.updateSecret(options) ### client.updateSecret(options)
@@ -396,26 +396,26 @@ Update an existing secret in Infisical.
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" optional> <ParamField query="Parameters" type="object" optional>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="secret_name" type="string" required> <ParamField query="secret_name" type="string" required>
The key of the secret to update. The key of the secret to update.
</ParamField> </ParamField>
<ParamField query="secret_value" type="string" required> <ParamField query="secret_value" type="string" required>
The new value of the secret. The new value of the secret.
</ParamField> </ParamField>
<ParamField query="project_id" type="string" required> <ParamField query="project_id" type="string" required>
The project ID where the secret lives in. The project ID where the secret lives in.
</ParamField> </ParamField>
<ParamField query="environment" type="string" required> <ParamField query="environment" type="string" required>
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from. The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
</ParamField> </ParamField>
<ParamField query="path" type="string" optional> <ParamField query="path" type="string" optional>
The path from where secret should be updated. The path from where secret should be updated.
</ParamField> </ParamField>
<ParamField query="type" type="string" optional> <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". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
### client.deleteSecret(options) ### client.deleteSecret(options)
@@ -433,23 +433,23 @@ Delete a secret in Infisical.
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" optional> <ParamField query="Parameters" type="object" optional>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="secret_name" type="string"> <ParamField query="secret_name" type="string">
The key of the secret to update. The key of the secret to update.
</ParamField> </ParamField>
<ParamField query="project_id" type="string" required> <ParamField query="project_id" type="string" required>
The project ID where the secret lives in. The project ID where the secret lives in.
</ParamField> </ParamField>
<ParamField query="environment" type="string" required> <ParamField query="environment" type="string" required>
The slug name (dev, prod, etc) of the environment from where secrets should be fetched from. The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
</ParamField> </ParamField>
<ParamField query="path" type="string" optional> <ParamField query="path" type="string" optional>
The path from where secret should be deleted. The path from where secret should be deleted.
</ParamField> </ParamField>
<ParamField query="type" type="string" optional> <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". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
## Cryptography ## Cryptography
@@ -480,14 +480,14 @@ encryptedData = client.encryptSymmetric(encryptOptions)
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" required> <ParamField query="Parameters" type="object" required>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="plaintext" type="string"> <ParamField query="plaintext" type="string">
The plaintext you want to encrypt. The plaintext you want to encrypt.
</ParamField> </ParamField>
<ParamField query="key" type="string" required> <ParamField query="key" type="string" required>
The symmetric key to use for encryption. The symmetric key to use for encryption.
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
#### Returns (object) #### Returns (object)
@@ -512,20 +512,20 @@ decryptedString = client.decryptSymmetric(decryptOptions)
#### Parameters #### Parameters
<ParamField query="Parameters" type="object" required> <ParamField query="Parameters" type="object" required>
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="ciphertext" type="string"> <ParamField query="ciphertext" type="string">
The ciphertext you want to decrypt. The ciphertext you want to decrypt.
</ParamField> </ParamField>
<ParamField query="key" type="string" required> <ParamField query="key" type="string" required>
The symmetric key to use for encryption. The symmetric key to use for encryption.
</ParamField> </ParamField>
<ParamField query="iv" type="string" required> <ParamField query="iv" type="string" required>
The initialization vector to use for decryption. The initialization vector to use for decryption.
</ParamField> </ParamField>
<ParamField query="tag" type="string" required> <ParamField query="tag" type="string" required>
The authentication tag to use for decryption. The authentication tag to use for decryption.
</ParamField> </ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>
#### Returns (string) #### Returns (string)
+11 -12
View File
@@ -10,24 +10,23 @@ From local development to production, Infisical SDKs provide the easiest way for
- Fetch secrets on demand - Fetch secrets on demand
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Node" href="https://github.com/Infisical/node-sdk-v2" icon="node" color="#68a063"> <Card title="Node.js" href="https://github.com/Infisical/node-sdk-v2?tab=readme-ov-file#infisical-nodejs-sdk" icon="node" color="#68a063">
Manage secrets for your Node application on demand Manage secrets for your Node application on demand
</Card> </Card>
<Card href="https://github.com/Infisical/python-sdk-official" title="Python" icon="python" color="#4c8abe"> <Card href="https://github.com/Infisical/python-sdk-official?tab=readme-ov-file#infisical-python-sdk" title="Python" icon="python" color="#4c8abe">
Manage secrets for your Python application on demand Manage secrets for your Python application on demand
</Card> </Card>
<Card href="https://github.com/Infisical/java-sdk?tab=readme-ov-file#infisical-nodejs-sdk" title="Java" icon="java" color="#e41f23"> <Card href="https://github.com/Infisical/java-sdk?tab=readme-ov-file#infisical-java-sdk" title="Java" icon="java" color="#e41f23">
Manage secrets for your Java application on demand Manage secrets for your Java application on demand
</Card> </Card>
<Card href="/sdks/languages/go" title="Go" icon="golang" color="#367B99"> <Card href="/sdks/languages/go" title="Go" icon="golang" color="#367B99">
Manage secrets for your Go application on demand Manage secrets for your Go application on demand
</Card> </Card>
<Card href="/sdks/languages/csharp" title="C#" icon="bars" color="#368833"> <Card href="https://github.com/Infisical/infisical-dotnet-sdk?tab=readme-ov-file#infisical-net-sdk" title=".NET" icon="bars" color="#368833">
Manage secrets for your C#/.NET application on demand Manage secrets for your .NET application on demand
</Card> </Card>
<Card href="/sdks/languages/ruby" title="Ruby" icon="diamond" color="#367B99">
<Card href="/sdks/languages/ruby" title="Ruby" icon="diamond" color="#367B99"> Manage secrets for your Ruby application on demand
Manage secrets for your Ruby application on demand
</Card> </Card>
</CardGroup> </CardGroup>