Skip to content

Commit 17d70c9

Browse files
ci-stytchStytch Codegen Bot
ci-stytch
and
Stytch Codegen Bot
authored
Documentation updates (#58)
Co-authored-by: Stytch Codegen Bot <support@stytch.com>
1 parent a073078 commit 17d70c9

39 files changed

Lines changed: 674 additions & 194 deletions

‎Stytch.net/Clients/b2b/RBACOrganizations.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ public RBACOrganizations(HttpClient client, ClientConfig config)
2929
}
3030

3131
/// <summary>
32+
///
33+
/// The organization RBAC policy feature is currently in private beta and must be enabled for your
34+
/// Workspace. Please contact Stytch support at support@stytch.com to request access.
35+
///
3236
/// Get the active RBAC Policy for a specific Organization within your Stytch Project. An Organization RBAC
3337
/// Policy contains the roles that have been defined specifically for that organization, allowing for
3438
/// organization-specific permissioning models.
@@ -77,6 +81,10 @@ B2BRBACOrganizationsGetOrgPolicyRequest request
7781
}
7882
}
7983
/// <summary>
84+
///
85+
/// The organization RBAC policy feature is currently in private beta and must be enabled for your
86+
/// Workspace. Please contact Stytch support at support@stytch.com to request access.
87+
///
8088
/// Set the RBAC Policy for a specific Organization within your Stytch Project. An Organization RBAC Policy
8189
/// allows you to define roles that are specific to that organization, providing fine-grained control over
8290
/// permissions at the organization level.

‎Stytch.net/Clients/b2b/Sessions.cs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,10 +251,7 @@ B2BSessionsExchangeRequest request
251251
/// This session can be used with the Stytch SDKs and APIs.
252252
///
253253
/// The Access Token must contain the `full_access` scope (only available to First Party clients) and must
254-
/// not be more than 5 minutes old. Access Tokens may only be exchanged a single time.
255-
///
256-
/// The Member Session returned will be the same Member Session that was active in your application (the
257-
/// authorizing party) during the initial authorization flow.
254+
/// not be more than 5 minutes old. Access Tokens may only be exchanged a single time.
258255
///
259256
/// Because the Member previously completed MFA and satisfied all Organization authentication requirements
260257
/// at the time of the original Access Token issuance, this endpoint will never return an

‎Stytch.net/Clients/consumer/M2MClients.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ M2MClientsSearchRequest request
108108
}
109109
}
110110
/// <summary>
111-
/// Updates an existing M2M Client. You can use this endpoint to activate or deactivate a M2M Client by
111+
/// Updates an existing M2M Client. You can use this endpoint to activate or deactivate an M2M Client by
112112
/// changing its `status`. A deactivated M2M Client will not be allowed to perform future token exchange
113113
/// flows until it is reactivated.
114114
///
115-
/// **Important:** Deactivating a M2M Client will not invalidate any existing JWTs issued to the client,
115+
/// **Important:** Deactivating an M2M Client will not invalidate any existing JWTs issued to the client,
116116
/// only prevent it from receiving new ones.
117117
/// To protect more-sensitive routes, pass a lower `max_token_age` value
118118
/// when[authenticating the token](https://stytch.com/docs/b2b/api/authenticate-m2m-token)[authenticating the token](https://stytch.com/docs/api/authenticate-m2m-token).
@@ -156,7 +156,7 @@ M2MClientsUpdateRequest request
156156
/// <summary>
157157
/// Deletes the M2M Client.
158158
///
159-
/// **Important:** Deleting a M2M Client will not invalidate any existing JWTs issued to the client, only
159+
/// **Important:** Deleting an M2M Client will not invalidate any existing JWTs issued to the client, only
160160
/// prevent it from receiving new ones.
161161
/// To protect more-sensitive routes, pass a lower `max_token_age` value
162162
/// when[authenticating the token](https://stytch.com/docs/b2b/api/authenticate-m2m-token)[authenticating the token](https://stytch.com/docs/api/authenticate-m2m-token).

‎Stytch.net/Clients/consumer/MagicLinks.cs‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,18 +72,32 @@ MagicLinksAuthenticateRequest request
7272
}
7373
}
7474
/// <summary>
75-
/// Create an Embeddable Magic Link token for a User. Access to this endpoint is restricted. To enable it,
76-
/// please send us a note at support@stytch.com.
75+
/// Create an Embeddable Magic Link token for a User.
7776
///
78-
/// ### Next steps
79-
/// Send the returned `token` value to the end user in a link which directs to your application. When the
80-
/// end user follows your link, collect the token, and call
81-
/// [Authenticate Magic Link](https://stytch.com/docs/api/authenticate-magic-link) to complete
82-
/// authentication.
77+
/// ### Important usage notes
8378
///
84-
/// **Note:** Authenticating an Embeddable Magic Link token will **not** result in any of the Stytch User's
85-
/// factors (email address or phone number) being marked as verified, as Stytch cannot confirm where the
86-
/// user received the token.
79+
/// Carefully review the following notes before using Embeddable Magic Links:
80+
///
81+
/// * Embeddable Magic Link tokens are **sensitive values**. You should handle and store them securely.
82+
/// * Authenticating an Embeddable Magic Link token will not mark any of a user's delivery factors (email
83+
/// address or phone number) as verified, since we cannot confirm how the token was sent to the user.
84+
/// * Embeddable Magic Links are only available in our Consumer API, and not our B2B API.
85+
///
86+
/// When sending Embeddable Magic Links via email:
87+
///
88+
/// * Deliverability is paramount. Carefully test your email copy to ensure it reaches your users' inboxes.
89+
/// Small changes can result in your emails being sent to spam.
90+
/// * In some cases, email security bots may follow links within incoming emails before your users open
91+
/// them. This consumes the Embeddable Magic Link token, preventing the user from logging in when they later
92+
/// click the link. Our Email Magic Links product automatically prevents this (details
93+
/// [here](https://stytch.com/docs/consumer-auth/authentication/magic-links/redirect-routing)). However,
94+
/// when sending your own emails containing Embeddable Magic Links, you'll be responsible for detecting and
95+
/// stopping bot traffic using tools like CAPTCHA or
96+
/// [Device Fingerprinting](https://stytch.com/docs/fraud-risk/device-fingerprinting/overview).
97+
///
98+
/// We also recommend checking out our
99+
/// [Trusted Auth Tokens](https://stytch.com/docs/consumer-auth/authentication/trusted-auth-tokens/overview)
100+
/// product, which is available in both our Consumer and B2B APIs and can be a better fit for some use cases.
87101
/// </summary>
88102
public async Task<MagicLinksCreateResponse> Create(
89103
MagicLinksCreateRequest request

‎Stytch.net/Clients/consumer/Sessions.cs‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,9 +202,6 @@ SessionsMigrateRequest request
202202
/// underlying User.
203203
/// This session can be used with the Stytch SDKs and APIs.
204204
///
205-
/// The Session returned will be the same Session that was active in your application (the authorizing
206-
/// party) during the initial authorization flow.
207-
///
208205
/// The Access Token must contain the `full_access` scope (only available to First Party clients) and must
209206
/// not be more than 5 minutes old. Access Tokens may only be exchanged a single time.
210207
/// </summary>

‎Stytch.net/Clients/consumer/WebAuthn.cs‎

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ public WebAuthn(HttpClient client, ClientConfig config)
3838
/// from
3939
/// [public_key_credential_creation_options](https://w3c.github.io/webauthn/#dictionary-makecredentialoptions)
4040
/// passed to the [navigator.credentials.create()](https://www.w3.org/TR/webauthn-2/#sctn-createCredential)
41-
/// request via the public key argument. We recommend using the `create()` wrapper provided by the
42-
/// webauthn-json library.
41+
/// request via the public key argument.
4342
///
44-
/// If you are not using the [webauthn-json](https://github.com/github/webauthn-json) library, the
45-
/// `public_key_credential_creation_options` will need to be converted to a suitable public key by
46-
/// unmarshalling the JSON, base64 decoding the user ID field, and converting user ID and the challenge
47-
/// fields into an array buffer.
43+
/// When using built-in browser methods like `navigator.credentials.create()`, set the
44+
/// `use_base64_url_encoding` option to `true`.
45+
///
46+
/// See our [WebAuthn setup guide](https://stytch.com/docs/guides/webauthn/api) for additional usage
47+
/// instructions and example code.
4848
/// </summary>
4949
public async Task<WebAuthnRegisterStartResponse> RegisterStart(
5050
WebAuthnRegisterStartRequest request
@@ -87,12 +87,8 @@ WebAuthnRegisterStartRequest request
8787
/// [navigator.credentials.create()](https://www.w3.org/TR/webauthn-2/#sctn-createCredential) request to
8888
/// this endpoint as the `public_key_credential` parameter.
8989
///
90-
/// If the [webauthn-json](https://github.com/github/webauthn-json) library's `create()` method was used,
91-
/// the response can be passed directly to the
92-
/// [register endpoint](https://stytch.com/docs/api/webauthn-register). If not, some fields (the client data
93-
/// and the attestation object) from the
94-
/// [navigator.credentials.create()](https://www.w3.org/TR/webauthn-2/#sctn-createCredential) response will
95-
/// need to be converted from array buffers to strings and marshalled into JSON.
90+
/// See our [WebAuthn setup guide](https://stytch.com/docs/guides/webauthn/api) for additional usage
91+
/// instructions and example code.
9692
/// </summary>
9793
public async Task<WebAuthnRegisterResponse> Register(
9894
WebAuthnRegisterRequest request
@@ -139,11 +135,13 @@ WebAuthnRegisterRequest request
139135
/// [navigator.credentials.get()](https://www.w3.org/TR/webauthn-2/#sctn-getAssertion) with the data from
140136
/// `public_key_credential_request_options` passed to the
141137
/// [navigator.credentials.get()](https://www.w3.org/TR/webauthn-2/#sctn-getAssertion) request via the
142-
/// public key argument. We recommend using the `get()` wrapper provided by the webauthn-json library.
138+
/// public key argument.
139+
///
140+
/// When using built-in browser methods like `navigator.credentials.get()`, set the
141+
/// `use_base64_url_encoding` option to `true`.
143142
///
144-
/// If you are not using the [webauthn-json](https://github.com/github/webauthn-json) library, `the
145-
/// public_key_credential_request_options` will need to be converted to a suitable public key by
146-
/// unmarshalling the JSON and converting some the fields to array buffers.
143+
/// See our [WebAuthn setup guide](https://stytch.com/docs/guides/webauthn/api) for additional usage
144+
/// instructions and example code.
147145
/// </summary>
148146
public async Task<WebAuthnAuthenticateStartResponse> AuthenticateStart(
149147
WebAuthnAuthenticateStartRequest request
@@ -186,11 +184,8 @@ WebAuthnAuthenticateStartRequest request
186184
/// [navigator.credentials.get()](https://www.w3.org/TR/webauthn-2/#sctn-getAssertion) request to the
187185
/// authenticate endpoint.
188186
///
189-
/// If the [webauthn-json](https://github.com/github/webauthn-json) library's `get()` method was used, the
190-
/// response can be passed directly to the
191-
/// [authenticate endpoint](https://stytch.com/docs/api/webauthn-authenticate). If not some fields from the
192-
/// [navigator.credentials.get()](https://www.w3.org/TR/webauthn-2/#sctn-getAssertion) response will need to
193-
/// be converted from array buffers to strings and marshalled into JSON.
187+
/// See our [WebAuthn setup guide](https://stytch.com/docs/guides/webauthn/api) for additional usage
188+
/// instructions and example code.
194189
/// </summary>
195190
public async Task<WebAuthnAuthenticateResponse> Authenticate(
196191
WebAuthnAuthenticateRequest request

‎Stytch.net/Models/B2B/DiscoveryIntermediateSessions.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public class B2BDiscoveryIntermediateSessionsExchangeRequest
7373
/// pre-emptively send a one-time passcode (OTP) to the Member's phone number. The locale argument will be
7474
/// used to determine which language to use when sending the passcode.
7575
///
76-
/// Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/),
76+
/// Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/),
7777
/// e.g. `"en"`.
7878
///
7979
/// Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese

‎Stytch.net/Models/B2B/DiscoveryOrganizations.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,11 @@ public class B2BDiscoveryOrganizationsCreateResponse
401401
[JsonProperty("member")]
402402
public Member Member { get; set; }
403403
/// <summary>
404+
/// The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
405+
/// </summary>
406+
[JsonProperty("organization")]
407+
public Organization Organization { get; set; }
408+
/// <summary>
404409
/// Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step
405410
/// to log in to the Organization.
406411
/// </summary>
@@ -434,11 +439,6 @@ public class B2BDiscoveryOrganizationsCreateResponse
434439
[JsonProperty("member_session")]
435440
public MemberSession MemberSession { get; set; }
436441
/// <summary>
437-
/// The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
438-
/// </summary>
439-
[JsonProperty("organization")]
440-
public Organization Organization { get; set; }
441-
/// <summary>
442442
/// Information about the MFA requirements of the Organization and the Member's options for fulfilling MFA.
443443
/// </summary>
444444
[JsonProperty("mfa_required")]

‎Stytch.net/Models/B2B/MagicLinks.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public class B2BMagicLinksAuthenticateRequest
7979
/// pre-emptively send a one-time passcode (OTP) to the Member's phone number. The locale argument will be
8080
/// used to determine which language to use when sending the passcode.
8181
///
82-
/// Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/),
82+
/// Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/),
8383
/// e.g. `"en"`.
8484
///
8585
/// Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese

‎Stytch.net/Models/B2B/MagicLinksEmail.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,14 @@ public class B2BMagicLinksEmailInviteRequest
7373
[JsonProperty("untrusted_metadata")]
7474
public object UntrustedMetadata { get; set; }
7575
/// <summary>
76-
/// Use a custom template for invite emails. By default, it will use your default email template. The
77-
/// template must be a template
78-
/// using our built-in customizations or a custom HTML email for Magic Links - Invite.
76+
/// Use a custom template for invite emails. By default, it will use your default email template. Templates
77+
/// can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in
78+
/// customization options or custom HTML templates with type “Magic Links - Invite”.
7979
/// </summary>
8080
[JsonProperty("invite_template_id")]
8181
public string InviteTemplateId { get; set; }
8282
/// <summary>
83-
/// Used to determine which language to use when sending the user this delivery method. Parameter is a
83+
/// Used to determine which language to use when sending the user this delivery method. Parameter is an
8484
/// [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
8585
///
8686
/// Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian
@@ -188,21 +188,21 @@ public class B2BMagicLinksEmailLoginOrSignupRequest
188188
[JsonProperty("pkce_code_challenge")]
189189
public string PkceCodeChallenge { get; set; }
190190
/// <summary>
191-
/// Use a custom template for login emails. By default, it will use your default email template. The
192-
/// template must be from Stytch's
193-
/// built-in customizations or a custom HTML email for Magic Links - Login.
191+
/// Use a custom template for login emails. By default, it will use your default email template. Templates
192+
/// can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in
193+
/// customization options or custom HTML templates with type “Magic Links - Login”.
194194
/// </summary>
195195
[JsonProperty("login_template_id")]
196196
public string LoginTemplateId { get; set; }
197197
/// <summary>
198198
/// Use a custom template for signup emails. By default, it will use your default email template. The
199199
/// template must be from Stytch's
200-
/// built-in customizations or a custom HTML email for Magic Links - Signup.
200+
/// built-in customizations or a custom HTML email for “Magic Links - Signup”.
201201
/// </summary>
202202
[JsonProperty("signup_template_id")]
203203
public string SignupTemplateId { get; set; }
204204
/// <summary>
205-
/// Used to determine which language to use when sending the user this delivery method. Parameter is a
205+
/// Used to determine which language to use when sending the user this delivery method. Parameter is an
206206
/// [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
207207
///
208208
/// Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian

0 commit comments

Comments
 (0)