{ "opencollection": "1.0.0", "info": { "name": "Stytch B2B Authentication Application Password API", "version": "2.0.0" }, "items": [ { "info": { "name": "Password", "type": "folder" }, "items": [ { "info": { "name": "Strengthcheck", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/passwords/strength_check", "body": { "type": "json", "data": "{}" } }, "docs": "This API allows you to check whether the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.\n\nThis endpoint adapts to your Project's password strength configuration.\nIf you're using [zxcvbn](https://stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid if the strength score is >= 3.\nIf you're using [LUDS](https://stytch.com/docs/guides/passwords/strength-policy), your passwords are" }, { "info": { "name": "Migrate", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/passwords/migrate", "body": { "type": "json", "data": "{}" } }, "docs": "\n**Warning:** This endpoint marks the Member's email address as verified. Do **not** use this endpoint unless the user has already verified their email address in your application. \n\nAdds an existing password to a Member's email that doesn't have a password yet.\n\nWe support migrating members from passwords stored with bcrypt, scrypt, argon2, MD-5, SHA-1, SHA-512, and PBKDF2. This endpoint has a rate limit of 100 requests per second.\n\nThe Member's email will be marked as verified when you use thi" }, { "info": { "name": "Authenticate", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/passwords/authenticate", "body": { "type": "json", "data": "{}" } }, "docs": "Authenticate a member with their email address and password. This endpoint verifies that the member has a password currently set, and that the entered password is correct.\n\nIf you have breach detection during authentication enabled in your [password strength policy](https://stytch.com/docs/b2b/guides/passwords/strength-policy) and the member's credentials have appeared in the HaveIBeenPwned dataset, this endpoint will return a `member_reset_password` error even if the member enters a correct pas" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/passwords", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user with a password. If `session_duration_minutes` is specified, a new session will be started as well.\n\nIf a user with this email already exists in your Stytch project, this endpoint will return a `duplicate_email` error. To add a password to an existing passwordless user, you'll need to either call the [Migrate password endpoint](https://stytch.com/docs/api/password-migrate) or prompt the user to complete one of our password reset flows.\n\nThis endpoint will return an error if the" }, { "info": { "name": "Authenticate", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/passwords/authenticate", "body": { "type": "json", "data": "{}" } }, "docs": "Authenticate a user with their email address and password. This endpoint verifies that the user has a password currently set, and that the entered password is correct. There are two instances where the endpoint will return a `reset_password` error even if they enter their previous password:\n\n**One:** The user's credentials appeared in the HaveIBeenPwned dataset. We force a password reset to ensure that the user is the legitimate owner of the email address, and not a malicious actor abusing the c" }, { "info": { "name": "Strengthcheck", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/passwords/strength_check", "body": { "type": "json", "data": "{}" } }, "docs": "This API allows you to check whether or not the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.\n\nThis endpoint adapts to your Project's password strength configuration. If you're using [zxcvbn](https://stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid if the strength score is >= 3. If you're using [LUDS](https://stytch.com/docs/guides/passwords/strength-policy), your passwo" }, { "info": { "name": "Migrate", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/passwords/migrate", "body": { "type": "json", "data": "{}" } }, "docs": "Adds an existing password to a User's email that doesn't have a password yet. We support migrating users from passwords stored with `bcrypt`, `scrypt`, `argon2`, `MD-5`, `SHA-1`, `SHA-512`, or `PBKDF2`. This endpoint has a rate limit of 100 requests per second." }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://api.stytch.com/pwa/v3/projects/:project_slug/environments/:environment_slug/password_strength_config", "params": [ { "name": "project_slug", "value": "", "type": "path" }, { "name": "environment_slug", "value": "", "type": "path" } ] }, "docs": "Get retrieves the password strength configuration for an environment." }, { "info": { "name": "Set", "type": "http" }, "http": { "method": "PUT", "url": "https://api.stytch.com/pwa/v3/projects/:project_slug/environments/:environment_slug/password_strength_config", "params": [ { "name": "project_slug", "value": "", "type": "path" }, { "name": "environment_slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set updates the password strength configuration for an environment." } ] } ], "bundled": true }