You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: Update JWT authentication options in authentication documentation
This commit updates the options for JWT authentication in the authentication documentation. It clarifies the purpose and usage of each option, including `enabled`, `allowAnonymousEndpoints`, `certificate`, `algorithm`, `issuer`, `secretKey`, `expiry`, `validateLifetime`, `validAudience`, and `validateAudience`. The changes ensure that the documentation accurately reflects the functionality of the JWT authentication feature.
Fixes #123
Extend Program.cs -> use WebHostBuilder or HostBuilder to setup the Azure Key Vault configuration.
39
39
40
+
You can use different ways to setup the Azure Key Vault.
41
+
1. By using Managed Identity (User Assigned Managed Identity or System Assigned Managed Identity)
42
+
2. By using RBAC (Role Based Access Control)
43
+
3. By using Certificate
44
+
45
+
46
+
#### Managed Identity or RBAC
40
47
```cs
41
48
builder.Host
42
49
.UseAzureKeyVault();
43
50
```
44
51
52
+
#### Certificate
53
+
```cs
54
+
builder.Host
55
+
.UseAzureKeyVaultWithCertificate();
56
+
```
57
+
58
+
45
59
### Options
46
60
47
61
`enabled` - Enable or disable the Azure Key Vault configuration. Default is false
48
62
49
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`.
50
64
51
-
`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
+
`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.
66
+
67
+
`azureADCertThumbprint` - The client id. To be used with Certificate authentication.
68
+
69
+
`azureADApplicationId` - The Active Directory Application id. To be used with Certificate authentication.
70
+
71
+
`azureADDirectoryId` - The Azure EntraID tenant Id. To be used with Certificate authentication.
72
+
52
73
53
74
**NOTE:** In case of RBAC, you don't need to set the managed identity id.
Copy file name to clipboardExpand all lines: content/en/library/http-client/index.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,11 +68,11 @@ public class SomeService
68
68
69
69
### Options
70
70
71
-
`type` - sets the IHttpClient message handler, if none is specified then the default handler will be used, other possible values: consul, fabio.
71
+
`type` - It sets the IHttpClient message handler, if none is specified then the default handler will be used, other possible values: consul, fabio.
72
72
73
-
`retries` - number of HTTP request retries using an exponential backoff.
73
+
`retries` - The number of HTTP request retries using an exponential backoff.
74
74
75
-
`services` - dictionary (map) of service_name:service_url values that can be used to invoke the other web services without a need to hardcode the configuration URLs, especially useful when service discovery mechanism or load balancer is available.
75
+
`services` - The dictionary (map) of service_name:service_url values that can be used to invoke the other web services without a need to hardcode the configuration URLs, especially useful when service discovery mechanism or load balancer is available.
76
76
77
77
**appsettings.json**
78
78
@@ -124,19 +124,19 @@ public static IGenocsBuilder RegisterGenocs(this IGenocsBuilder builder)
124
124
125
125
### Options
126
126
127
-
`enabled` - determines whether Consul integration is going to be available.
127
+
`enabled` - It determines whether Consul integration is going to be available.
128
128
129
-
`url` - URL of the Consul service.
129
+
`url` - The URL of the Consul service.
130
130
131
-
`service` - name of the service group (multiple instances of the same service will use the same service name).
131
+
`service` - The name of the service group (multiple instances of the same service will use the same service name).
132
132
133
-
`address` - address of the service.
133
+
`address` - The address of the service.
134
134
135
-
`port` - port under which the service is available.
135
+
`port` - The port under which the service is available.
136
136
137
-
`pingEnabled` - register health checks from Consul to validate the service availability (if the service will be offline, it will be removed after the pingInterval and removeAfterInterval timeouts).
137
+
`pingEnabled` - Register health checks from Consul to validate the service availability (if the service will be offline, it will be removed after the pingInterval and removeAfterInterval timeouts).
138
138
139
-
`pingEndpoint` - an endpoint that should be called when performing the healt check by Consul.
139
+
`pingEndpoint` - The endpoint that is called when performing the health check by Consul.
140
140
141
141
**appsettings.json**
142
142
@@ -192,11 +192,11 @@ public static IGenocsBuilder RegisterGenocs(this IGenocsBuilder builder)
192
192
193
193
### Options
194
194
195
-
`enabled` - determines whether Fabio integration is going to be available.
195
+
`enabled` - It determines whether Fabio integration is going to be available.
196
196
197
-
`url` - URL of the Fabio service.
197
+
`url` - The URL of the Fabio service.
198
198
199
-
`service` - name of the service group used for the Consul registration.
199
+
`service` - the name of the service group used for the Consul registration.
0 commit comments