[DNM] Docs updates test #300
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
bgier-stytch
left a comment
bgier-stytch
left a comment
There was a problem hiding this comment.
Adding some comments on suggested changes to PW files
mia-stytch
reviewed
Nov 20, 2025
mia-stytch
reviewed
Nov 20, 2025
mia-stytch
reviewed
Nov 20, 2025
| - resource_id: A unique identifier of the RBAC Resource, provided by the developer and intended to be human-readable. A `resource_id` is not allowed to start with `stytch`, which is a special prefix used for Stytch default Resources with reserved `resource_id`s. | ||
| - description: A human-readable description of the RBAC resource, role, or scope that explains its purpose and permissions. | ||
| - actions: An array of actions that can be performed on the given resource. |
There was a problem hiding this comment.
We've removed a lot of detail for actions. The information is probably not necessary to document here, but maybe we can link to an existing list of reserved actions?
logan-stytch
force-pushed
the
logan/dnm-codegen-test
branch
4 times, most recently
from
4d05842 to
ded3a8b
Compare
logan-stytch
force-pushed
the
logan/dnm-codegen-test
branch
from
ded3a8b to
baa622e
Compare
bschmeisser-stytch
approved these changes
Nov 24, 2025
| - session_jwt: The JSON Web Token (JWT) for a given Stytch Session. | ||
| - organization: The [Organization object](https://stytch.com/docs/b2b/api/organization-object). | ||
| - member_id: Globally unique UUID that identifies a specific Member. When making API calls, you may use an `external_id` in place of the `member_id` if one is set for the member. | ||
| - method_id: The unique identifier for a specific authentication method instance (e.g., a password, TOTP, or phone number). |
Member
There was a problem hiding this comment.
Should we preserve email as a suggestion?
Comment on lines
+75
to
+76
| - locale: Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. | ||
| Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English. |
There was a problem hiding this comment.
If correct, the lost info on locale seems useful here
Suggested change
| - locale: Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. | |
| Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English. | |
| - locale: If the Member needs to complete an MFA step, and the Member has a phone number, this endpoint will pre-emptively send a one-time passcode (OTP) to the Member's phone number. This locale argument will be used to determine which language to use when sending the passcode. | |
| Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. | |
| Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English. |
| If the `session_duration_minutes` parameter is not specified, a Stytch session will not be created. | ||
| - session_custom_claims: Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in `session_duration_minutes`. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To delete a key, supply a null value. | ||
| Custom claims made with reserved claims ("iss", "sub", "aud", "exp", "nbf", "iat", "jti") will be ignored. Total custom claims size cannot exceed four kilobytes. | ||
| - locale: Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. |
There was a problem hiding this comment.
same comment
Suggested change
| - locale: Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. | |
| - locale: If the Member needs to complete an MFA step, and the Member has a phone number, this endpoint will pre-emptively send a one-time passcode (OTP) to the Member's phone number. The locale argument will be used to determine which language to use when sending the passcode. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. |
|
|
||
| `OR` – **[DEPRECATED]** the operator will return any matches to at least one of the operand values you supply. This parameter is retained for legacy use cases only and is no longer supported. We strongly recommend breaking down complex queries into multiple search queries instead. | ||
| - operands: An array of operand objects that contains all of the filters and values to apply to your search search query. | ||
| - operator: The action to perform on the operands, either `AND` or `OR`. |
There was a problem hiding this comment.
Should or actually be marked deprecated?
Comment on lines
+217
to
+222
| - reasons: A list of reasons or explanations for a decision or status. | ||
| - detected_device_type: The type of device detected from the User-Agent (e.g., desktop, mobile, tablet). | ||
| - is_authentic_device: A boolean indicating whether the device has been verified as authentic and trustworthy. | ||
| - verdict_reason_overrides: Custom overrides for authorization verdict reasons, allowing customization of denial messages. | ||
| - rule_match_type: The matching strategy for the rule (e.g., exact, wildcard, regex). | ||
| - rule_match_identifier: The identifier or pattern used for rule matching. |
Contributor
There was a problem hiding this comment.
All of these are either incorrect or vague (e.g. 'wildcard/regex' for the rule match, 'decision/status' for reasons). I'd prefer we go back to the old descriptions
| - public_key: The public key for the WebAuthn credential in base64 format. | ||
| - credential_id: The unique identifier for a WebAuthn credential or passkey. | ||
| - webauthn_registration_id: Globally unique UUID that identifies a Passkey or WebAuthn registration in the Stytch API. The `webauthn_registration_id` is used when you need to operate on a specific User's WebAuthn registration. | ||
| - type: The type or category of the resource, method, or entity. |
Contributor
There was a problem hiding this comment.
This description is pretty vague
| See [Session object](https://stytch.com/docs/api/session-object) for complete response fields. | ||
|
|
||
| - user_device: If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `user_device` response field will contain information about the user's device attributes. | ||
| - user_device: If a valid `telemetry_id` was passed in the request and the Fingerprint Lookup API returned results, this field will contain information about the user's device attributes. |
Contributor
There was a problem hiding this comment.
Did we remove docs links from all of the inline docs?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.