Skip to content

Commit 099dfa3

Browse files
committed
chore: Update last modified dates in documentation and improve formatting for code blocks
1 parent d72143c commit 099dfa3

File tree

3 files changed

+41
-59
lines changed

3 files changed

+41
-59
lines changed

content/en/library/authentication/index.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title : "Authentication - JWT"
33
description: "Adds the integration with JWT using an available authentication middleware and system components to validate and grant the access tokens."
44
lead: ""
55
date: 2023-05-13T15:40:19+02:00
6-
lastmod: 2023-06-25T15:40:19+02:00
6+
lastmod: 2024-11-17T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -32,13 +32,13 @@ There are three different ways you can to create the access tokens:
3232

3333
- Using a certificate.
3434
- Using a secret key.
35-
- Using a OpenId external provider.
35+
- Using an OpenId external provider.
3636

37-
Using a certificate is the most secure way to create the access tokens. The certificate can be stored in the file system or in the Azure Key Vault.
37+
**Using a certificate** is the most secure way to create the access tokens. The certificate can be stored in the file system or in the Azure Key Vault.
3838

39-
Using a secret key is the simplest way to create the access tokens. The secret key is stored in the appsettings.json file.
39+
**Using a secret** key is the simplest way to create the access tokens. The secret key is stored in the appsettings.json file.
4040

41-
Using a OpenId external provider is the most flexible way to create the access tokens. The OpenId provider can be configured in the appsettings.json file.
41+
**Using an OpenId external provider** is the most flexible way to create the access tokens. The OpenId provider can be configured in the `appsettings.json` file.
4242

4343
## JWT authentication with CERTIFICATE
4444

@@ -161,31 +161,22 @@ To blacklist and deactivate the access tokens, use `IAccessTokenService` and inv
161161

162162
The default section name for the JWT settings is `jwt`. The following options are available:
163163

164-
`enabled` - If true then the JWT authentication is enabled.
165-
166-
`allowAnonymousEndpoints` - If true then the JWT authentication is disabled for the endpoints with the AllowAnonymous attribute.
167-
168-
`certificate` - Certificate used to issue or just validate the tokens (including private key or just the public one).
169-
170-
`algorithm` - The algorithm used to sign the tokens.
171-
172-
`issuer` - A party signing the tokens.
173-
174-
`secretKey` - A secret key used to create the access tokens (instead of using the certificate).
175-
176-
`expiry` - How long the token will remain valid.
177-
178-
`validateLifetime` - If true then the lifetime defined in expiryMinutes will be validated.
179-
180-
`validAudience` - An audience that can use the access tokens.
181-
182-
`validateAudience` - If true then the audience defined in validAudience will be validated.
164+
- `enabled` - If true then the JWT authentication is enabled.
165+
- `allowAnonymousEndpoints` - If true then the JWT authentication is disabled for the endpoints with the AllowAnonymous attribute.
166+
- `certificate` - Certificate used to issue or just validate the tokens (including private key or just the public one).
167+
- `algorithm` - The algorithm used to sign the tokens.
168+
- `issuer` - A party signing the tokens.
169+
- `secretKey` - A secret key used to create the access tokens (instead of using the certificate).
170+
- `expiry` - How long the token will remain valid.
171+
- `validateLifetime` - If true then the lifetime defined in expiryMinutes will be validated.
172+
- `validAudience` - An audience that can use the access tokens.
173+
- `validateAudience` - If true then the audience defined in validAudience will be validated.
183174

184175
## Settings
185176

186-
**appsettings.json**
177+
Use the following settings in the `appsettings.json` file according to your needs
187178

188-
``` json
179+
```json
189180
"jwt": {
190181
"enabled": true,
191182
"allowAnonymousEndpoints": [
@@ -241,7 +232,7 @@ The default section name for the JWT settings is `jwt`. The following options ar
241232

242233
Default settings for some variable has bee overwritten with the following configuration.
243234

244-
``` json
235+
```json
245236
"jwt": {
246237
"challenge": "Bearer",
247238
"metadataAddress": "/.well-known/openid-configuration",

content/en/library/azure-key-vault/index.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title : "Azure Key Vault"
33
description: "Genocs Library package for Azure Key Vault"
44
lead: ""
55
date: 2023-11-29T21:00:19+02:00
6+
lastmod: 2024-11-17T00:00:00+02:00
67
draft: false
78
images: []
89
menu:
@@ -58,25 +59,22 @@ builder.Host
5859

5960
### Options
6061

61-
`enabled` - Enable or disable the Azure Key Vault configuration. Default is false
62+
- `enabled` - Enable or disable the Azure Key Vault configuration. Default is false
63+
- `name` - Sets the key vault name to be used. If the key vault url is `https://kyvault.vault.azure.net/` then the name is `kyvault`.
64+
- `managedIdentityId` - Sets the managed identity id to be used. You can find the managed identity id in the Azure portal. The managed identity id is the object id of the managed identity.
65+
- `azureADCertThumbprint` - The client id. To be used with *Certificate authentication*.
66+
- `azureADApplicationId` - The Active Directory Application id. To be used with *Certificate authentication*.
67+
- `azureADDirectoryId` - The Azure EntraID tenant Id. To be used with *Certificate authentication*.
6268

63-
`name` - Sets the key vault name to be used. If the key vault url is `https://kyvault.vault.azure.net/` then the name is `kyvault`.
6469

65-
`managedIdentityId` - Sets the managed identity id to be used. You can find the managed identity id in the Azure portal. The managed identity id is the object id of the managed identity.
70+
> **NOTE:**
71+
>
72+
> In case of RBAC, you don't need to set the managed identity id.
6673
67-
`azureADCertThumbprint` - The client id. To be used with Certificate authentication.
6874

69-
`azureADApplicationId` - The Active Directory Application id. To be used with Certificate authentication.
75+
Use the following settings in the `appsettings.json` file according to your needs
7076

71-
`azureADDirectoryId` - The Azure EntraID tenant Id. To be used with Certificate authentication.
72-
73-
74-
**NOTE:** In case of RBAC, you don't need to set the managed identity id.
75-
76-
77-
**appsettings.json**
78-
79-
``` json
77+
```json
8078
"azureKeyVault": {
8179
"enabled": false,
8280
"name": "kyvault",

content/en/library/builder/index.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title : "Builder"
33
description: "Genocs builder is the entrypoint for the application builder."
44
lead: ""
55
date: 2023-12-20T17:40:19+02:00
6-
lastmod: 2023-12-20T17:40:19+02:00
6+
lastmod: 2024-11-17T00:00:00+02:00
77
draft: false
88
images: []
99
menu:
@@ -31,7 +31,7 @@ Extend `IServiceCollection` with `AddGenocs(builder.Configuration)` that will ge
3131

3232
This is what you need to do in the `Program.cs` file.
3333

34-
``` c#
34+
```csharp
3535
// Create a new WebApplication
3636
var builder = WebApplication.CreateBuilder(args);
3737

@@ -47,7 +47,7 @@ services.AddGenocs(builder.Configuration);
4747

4848
This is an example of how to setup the builder in the `Program.cs` file along with some other services.
4949

50-
``` c#
50+
```csharp
5151
using Genocs.Core.Builders;
5252
using Genocs.Core.Demo.WebApi.Infrastructure.Extensions;
5353
using Genocs.Core.Demo.WebApi.Options;
@@ -154,31 +154,24 @@ Log.CloseAndFlush();
154154

155155
## Options
156156

157-
`name` - The service name.
158-
159-
`service` - Service name used TBW.
160-
161-
`instance` - The service instance.
162-
163-
`version` - The service version.
164-
165-
`displayBanner` - If true then the banner is shown into the console.
166-
167-
`displayVersion` - If true then the service version is shown into the console. See `version` param.
157+
- `name` - The service name.
158+
- `service` - Service name used TBW.
159+
- `instance` - The service instance.
160+
- `version` - The service version.
161+
- `displayBanner` - If true then the banner is shown into the console.
162+
- `displayVersion` - If true then the service version is shown into the console. See `version` param.
168163

169164
## Settings
170165

171-
**appsettings.json**
172-
173166
Use the following settings in the `appsettings.json` file according to your needs.
174167

175-
``` json
168+
```json
176169
"app": {
177170
"name": "Service Name",
178171
"service": "service-name",
179172
"instance": "000001",
180173
"version": "v1.0",
181174
"displayBanner": true,
182175
"displayVersion": true
183-
},
176+
}
184177
```

0 commit comments

Comments
 (0)