Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 6cccfca

Browse files
committed
Fix API parameters to match SDK
1 parent ca4da8c commit 6cccfca

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

docs/reference/csharp/api/api.mdx

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,37 @@ Application.Run();
2121
The unique name of this API within the app. Subsequent calls to `api` with
2222
the same name will return the same object.
2323
</Property>
24-
<Property
25-
name="securityDefinitions"
26-
type="Dictionary<string, SecurityDefinition>"
27-
>
28-
Security definitions defined by this API.
29-
</Property>
30-
<Property name="security" type="Dictionary<string, string[]>">
31-
Security rules to apply with scopes to the entire API. Keys must match a
32-
`securityDefinition`.
33-
</Property>
34-
<Property name="SecurityDefinition">
35-
A `SecurityDefinition` object is one of the following:
24+
<Property name="ApiOptions">
25+
A set of options for configuring the API.
3626
<Properties nested>
37-
<Property name="issuer" type="string">
38-
The issuer for the JWT tokens e.g. `https://account.region.auth0.com`.
27+
<Property name="security" type="OidcOptions[]">
28+
Security options for the API.
29+
<Properties nested>
30+
<Property name="name" type="string">
31+
The name of the security option.
32+
</Property>
33+
<Property name="audiences" type="string[]">
34+
The audience (`aud`) claims that the issued JWT tokens must contain.
35+
</Property>
36+
<Property name="issuer" type="string">
37+
The URL of the token issuer, e.g., `https://example-issuer.com`.
38+
</Property>
39+
<Property name="scopes" type="string[]">
40+
A list of required scopes to access the API. Users must have these scopes in their tokens.
41+
</Property>
42+
</Properties>
3943
</Property>
40-
<Property name="audiences" type="string[]">
41-
The `aud` that will be applied to JWT tokens from the issuer.
44+
<Property name="basePath" type="string">
45+
The base path for the API.
46+
</Property>
47+
<Property name="middleware" type="Middleware<HttpContext>[]">
48+
Middleware applied to the API.
4249
</Property>
4350
</Properties>
4451
</Property>
4552
</Properties>
4653

54+
4755
## Notes
4856

4957
The `middleware` property on the `options` param is useful for applying universal middleware such as CORS headers or Auth, across an entire API from a single place.

0 commit comments

Comments
 (0)