Stytch Python

https://github.com/stytchauth/stytch-python
Admin
The Stytch Python library simplifies the integration of Stytch's user authentication infrastructure...
Tokens:81,887
Snippets:544
Trust Score:9.6
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### OAuth usage example (sync and async)

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-oauth.md

Shows how to start the OAuth flow with `attach`, authenticate with the returned token, and use the async variant.

```python
# Start the flow
attach = client.oauth.attach(provider="google")
print(attach.redirect_url)

# After the user returns with ?token=...
resp = client.oauth.authenticate(
    token="mZAXfEBS6x7DOYoip3rvIMMW5lgItikFK",
    session_duration_minutes=60,
)
print(resp.user_id, resp.session_token)

# Async
import asyncio

async def main():
    resp = await client.oauth.authenticate_async(token="mZAXfEBS6x7DOYoip3rvIMMW5lgItikFK")
    return resp
```

--------------------------------

### Usage examples for create, get, update, and search

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-users.md

Shows typical usage of the Users API: creating a user, fetching and updating, and searching with a filter.

```python
# Create a user
created = client.users.create(
    email="user@example.com",
    name={"first_name": "Ada", "last_name": "Lovelace"},
    trusted_metadata={"plan": "pro"},
)

# Fetch + update
user = client.users.get(user_id=created.user_id)
updated = client.users.update(
    user_id=user.user_id,
    name={"first_name": "Ada", "last_name": "King"},
)

# Search with a filter
resp = client.users.search(
    query={"operator": "AND", "operands": [{"filter_name": "email_address", "filter_value": ["user@example.com"]}]}
)
```

--------------------------------

### POST /v1/webauthn/authenticate/start

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts the WebAuthn authentication process.

```APIDOC
## POST /v1/webauthn/authenticate/start

### Description
Starts the WebAuthn authentication process.

### Method
POST

### Endpoint
/v1/webauthn/authenticate/start

### Parameters
#### Request Body
- **domain** (string) - Required - The domain.
- **user_id** (string) - Optional - The user ID.
- **return_passkey_credential_options** (boolean) - Optional - Whether to return passkey credential options.
- **use_base64_url_encoding** (boolean) - Optional - Whether to use base64 URL encoding.

### Response
#### Success Response (200)
- **AuthenticateStartResponse** - The response object.

```

--------------------------------

### POST /v1/webauthn/register/start

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts the WebAuthn registration process.

```APIDOC
## POST /v1/webauthn/register/start

### Description
Starts the WebAuthn registration process.

### Method
POST

### Endpoint
/v1/webauthn/register/start

### Parameters
#### Request Body
- **user_id** (string) - Required - The user ID.
- **domain** (string) - Required - The domain.
- **user_agent** (string) - Optional - The user agent.
- **authenticator_type** (string) - Optional - The authenticator type.
- **return_passkey_credential_options** (boolean) - Optional - Whether to return passkey credential options.
- **override_id** (string) - Optional - Override ID.
- **override_name** (string) - Optional - Override name.
- **override_display_name** (string) - Optional - Override display name.
- **use_base64_url_encoding** (boolean) - Optional - Whether to use base64 URL encoding.

### Response
#### Success Response (200)
- **RegisterStartResponse** - The response object.

```

--------------------------------

### POST /v1/crypto_wallets/authenticate/start

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts the crypto wallet authentication process.

```APIDOC
## POST /v1/crypto_wallets/authenticate/start

### Description
Starts the crypto wallet authentication process.

### Method
POST

### Endpoint
/v1/crypto_wallets/authenticate/start

### Parameters
#### Request Body
- **crypto_wallet_type** (string) - Required - The crypto wallet type.
- **crypto_wallet_address** (string) - Required - The crypto wallet address.
- **user_id** (string) - Optional - The user ID.
- **session_token** (string) - Optional - The session token.
- **session_jwt** (string) - Optional - The session JWT.
- **siwe_params** (object) - Optional - Sign-In with Ethereum parameters.

### Response
#### Success Response (200)
- **AuthenticateStartResponse** - The response object.

```

--------------------------------

### Install Stytch Python library with pip

Source: https://github.com/stytchauth/stytch-python/blob/main/README.md

Installs the Stytch Python library via pip. Run this in your terminal before using the library in your Python application.

```bash
pip install stytch
```

--------------------------------

### Usage Examples

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-sessions.md

Examples of remote authentication, local JWT verification with RBAC authorization check, and the combined authenticate_jwt method.

```APIDOC
## Usage Examples

### Remote authenticate
```python
resp = client.sessions.authenticate(
    session_token="WJtR5BCyX4t9J7S9Z2vH...",
    session_duration_minutes=60,
)
print(resp.session.session_id, resp.session_jwt)
```

### Local JWT verification (no network) with an RBAC authorization check
```python
session = client.sessions.authenticate_jwt_local(
    session_jwt=resp.session_jwt,
    max_token_age_seconds=300,
    authorization_check={"resource_id": "stytch.self", "action": "read"},
)
if session is not None:
    print(session.user_id)
```

### authenticate_jwt prefers local, falls back to remote
```python
auth = client.sessions.authenticate_jwt(session_jwt=resp.session_jwt)
```
```

--------------------------------

### Usage example for SyncClient and AsyncClient

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/core-http-client.md

Shows how to instantiate both clients and make a POST request. The sync client returns a ResponseWithJson; the async client must be awaited and closed explicitly.

```python
from stytch.core.http.client import SyncClient, AsyncClient

sync = SyncClient("project-test-abc", "secret-test-xyz")
res = sync.post("/v1/sessions/authenticate", {"session_token": "..."})
print(res.response.status_code, res.json)

async def main():
    async_client = AsyncClient("project-test-abc", "secret-test-xyz")
    res = await async_client.post("/v1/users", {"email": "a@b.com"})
    await async_client.close()
```

--------------------------------

### SSO usage example in Python

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-sso.md

Shows key SSO operations: create a SAML connection, authenticate with an SSO token, and list connections.

```python
# Create a SAML connection
conn = client.sso.saml.create_connection(
    organization_id="org-123",
    display_name="Okta",
    identity_provider="okta",
)

# Authenticate with an SSO token
resp = client.sso.authenticate(
    sso_token="sso-token-from-idp",
    session_duration_minutes=60,
)
print(resp.member_session.member_id, resp.organization.organization_id)

# List connections
connections = client.sso.get_connections(organization_id="org-123")
```

--------------------------------

### Create organization, create member, and get connected apps

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-organizations.md

Shows the typical workflow for creating an organization and a member, then retrieving the member's connected apps. The organization ID from the creation response is used to create the member, and the member ID is used to fetch connected apps.

```python
org = client.organizations.create(
    organization_name="Acme Co",
    organization_slug="acme-co",
    email_allowed_domains=["acme.co"],
)
org_id = org.organization.organization_id

member = client.organizations.members.create(
    organization_id=org_id,
    email_address="admin@acme.co",
    roles=["stytch_admin"],
)

sessions = client.organizations.members.get_connected_apps(
    organization_id=org_id, member_id=member.member_id
)
```

--------------------------------

### POST /v1/b2b/passwords/email/reset/start

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts a password reset via email.

```APIDOC
## POST /v1/b2b/passwords/email/reset/start

### Description
Starts a password reset via email.

### Method
POST

### Endpoint
/v1/b2b/passwords/email/reset/start

### Response
#### Success Response
- **ResetStartResponse** - The reset start result.
```

--------------------------------

### Async magic link login_or_create and authenticate

Source: https://github.com/stytchauth/stytch-python/blob/main/README.md

Shows the async versions of magic link email login_or_create and authenticate methods, using the same Client object as sync methods. The example sends a magic link to a sandbox email and then authenticates with the returned token.

```python
login_or_create_resp = await client.magic_links.email.login_or_create_async(
    email="sandbox@stych.com",
    login_magic_link_url="https://example.com/authenticate",
    signup_magic_link_url="https://example.com/authenticate",
)
print(login_or_create_resp)

auth_resp = await client.magic_links.authenticate(
    token="DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
)
print(resp)

```

```python
import stytch

client = stytch.B2BClient(
    project_id="project-live-c60c0abe-c25a-4472-a9ed-320c6667d317",
    secret="secret-live-80JASucyk7z_G8Z-7dVwZVGXL5NT_qGAQ2I=",
    # Optionally specify a custom base URL for all API calls
    # custom_base_url="https://api.custom-domain.com/",
)

```

--------------------------------

### Authenticate and Send Magic Link (Python)

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-magic-links.md

Shows basic token authentication, sending a login-or-create magic link, and asynchronous authentication with session parameters. The async example uses `authenticate_async` and includes `session_duration_minutes` and `session_custom_claims`.

```python
# Basic authenticate
resp = client.magic_links.authenticate(
    token="DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
)
print(resp.user_id)

# Send a login-or-create magic link, then authenticate async
client.magic_links.email.login_or_create(
    email="sandbox@stytch.com",
    login_magic_link_url="https://example.com/authenticate",
)

import asyncio

async def main():
    resp = await client.magic_links.authenticate_async(
        token="DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
        session_duration_minutes=60,
        session_custom_claims={"role": "admin"},
    )
    return resp
```

--------------------------------

### Usage example for ApiBase

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/core-api-base.md

Shows how to instantiate ApiBase and use url_for to encode an email address in a path parameter. The output demonstrates that '+' is encoded as %2B.

```python
from stytch.core.api_base import ApiBase

api_base = ApiBase("https://api.stytch.com/")
# Encodes the email so "+" is safe in the path
url = api_base.url_for("/v1/users/{user_id}", {"user_id": "user-test+1@example.com"})
print(url)  # https://api.stytch.com/v1/users/user-test%2B1%40example.com
```

--------------------------------

### Async usage with get_async methods

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-client.md

Shows async usage of the B2BClient, using await with get_async methods for organizations and sessions. The example defines an async main function that returns the sessions response.

```python
import stytch

client = stytch.B2BClient(project_id="project-test-...", secret="secret-test-...")

async def main():
    resp = await client.organizations.get_async(organization_id="org-123")
    sessions = await client.sessions.get_async(
        organization_id="org-123", member_id="member-456"
    )
    return sessions
```

--------------------------------

### Usage example for TOTPs

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-totps.md

Demonstrates creating a TOTP, authenticating with a code, recovering with a recovery code, and using the async variant. Recovery codes rotate after use.

```python
# Create a TOTP for a user
created = client.totps.create(user_id="user-123")
print(created.totp_id, created.secret, created.qr_code, created.recovery_codes)

# Authenticate with a 6-digit code from the authenticator app
resp = client.totps.authenticate(
    user_id="user-123",
    totp_code="123456",
    session_duration_minutes=60,
)
print(resp.session_token)

# Recover with a recovery code (rotates after use)
resp = client.totps.recover(user_id="user-123", recovery_code="code-1")

# Async
import asyncio

async def main():
    resp = await client.totps.authenticate_async(user_id="user-123", totp_code="123456")
    return resp
```

--------------------------------

### Usage examples for session authentication and exchange

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-sessions.md

Shows how to authenticate a member session with an RBAC check, perform local JWT verification, and exchange an intermediate session into an org session.

```python
# Authenticate a member session with an RBAC check
resp = client.sessions.authenticate(
    session_token="WJtR5BCyX4t9J7S9Z2vH...",
    authorization_check={"organization_id": "org-123", "resource_id": "stytch.self", "action": "read"},
)
print(resp.member_session.member_id)

# Local JWT verification
member_session = client.sessions.authenticate_jwt_local(
    session_jwt=resp.session_jwt,
    max_token_age_seconds=300,
)
if member_session is not None:
    print(member_session.organization_slug)

# Exchange an intermediate session into an org session
exchanged = client.sessions.exchange(organization_id="org-123")
```

--------------------------------

### POST /v1/connected_apps/clients/{client_id}/secrets/rotate/start

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts the rotation of a connected app client secret.

```APIDOC
## POST /v1/connected_apps/clients/{client_id}/secrets/rotate/start

### Description
Starts the rotation of a connected app client secret.

### Method
POST

### Endpoint
/v1/connected_apps/clients/{client_id}/secrets/rotate/start

### Parameters
#### Path Parameters
- **client_id** (string) - Required - The client ID.

### Response
#### Success Response (200)
- **RotateStartResponse** - The response object.

```

--------------------------------

### POST /v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Starts an email update for a member.

```APIDOC
## POST /v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update

### Description
Starts an email update for a member.

### Method
POST

### Endpoint
/v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The organization ID.
- **member_id** (string) - Required - The member ID.

### Response
#### Success Response
- **StartEmailUpdateResponse** - The response object.
```

--------------------------------

### POST /v1/oauth/attach

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-oauth.md

Starts the OAuth flow for a given provider (e.g. google, microsoft, github) and returns a redirect URL.

```APIDOC
## [POST] /v1/oauth/attach

### Description
Starts the OAuth flow for the specified provider and returns a redirect URL to begin the authentication process.

### Method
POST

### Endpoint
/v1/oauth/attach

### Parameters
#### Path Parameters
- **provider** (string) - Required - The OAuth provider identifier (e.g., "google", "microsoft", "github").

#### Query Parameters
None

#### Request Body
- **user_id** (string) - Optional - The Styth User ID to attach the OAuth account to.
- **session_token** (string) - Optional - An existing session token to link the OAuth registration to the existing user.
- **session_jwt** (string) - Optional - An existing session JWT to link the OAuth registration to the existing user.

### Request Example
{
  "provider": "google"
}

### Response
#### Success Response (200)
- **oauth_attach_token** (string) - A single-use token for connecting the Stytch User selection from an OAuth Attach request to the corresponding OAuth Start request.

#### Response Example
{
  "oauth_attach_token": "string"
}
```

```APIDOC
## [POST] /v1/oauth/authenticate

### Description
Authenticates a user with an OAuth token obtained from the redirect URL's `?token=` query parameter. Optionally extends an existing session or creates a new one.

### Method
POST

### Endpoint
/v1/oauth/authenticate

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **token** (string) - Required - The OAuth token from the `?token=` query parameter of the redirect URL.
- **session_token** (string) - Optional - Existing session to extend.
- **session_duration_minutes** (integer) - Optional - New/extension session lifetime (min 5, max 527040).
- **session_jwt** (string) - Optional - Existing session to extend.
- **session_custom_claims** (object) - Optional - Custom session claims.
- **code_verifier** (string) - Optional - PKCE code verifier (base64url).
- **telemetry_id** (string) - Optional - Fingerprint telemetry ID.

### Request Example
```json
{
  "token": "mZAXfEBS6x7DOYoip3rvIMMW5lgItikFK",
  "session_duration_minutes": 60
}
```

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier of the authenticated user.
- **provider_subject** (string) - The subject identifier from the OAuth provider.
- **provider_type** (string) - The type of the OAuth provider.
- **session_token** (string) - The session token for the authenticated user.
- **session_jwt** (string) - The session JWT for the authenticated user.
- **provider_values** (object) - Provider-specific data returned by the identity provider.
- **user** (object) - The Stytch User object.
- **reset_sessions** (boolean) - Whether existing sessions were reset.
- **oauth_user_registration_id** (string) - The OAuth user registration ID.
- **user_session** (object, optional) - The user's session object.
- **user_device** (object, optional) - Device information.

#### Response Example
```json
{
  "user_id": "user-123",
  "provider_subject": "google-oauth2|1234567890",
  "provider_type": "google",
  "session_token": "mZAXfEBS6x7DOYoip3rvIMMW5lgItikFK",
  "session_jwt": "eyJhbGciOi...",
  "provider_values": {
    "access_token": "ya29...",
    "refresh_token": "1//...",
    "id_token": "eyJ...",
    "scopes": ["openid", "email"],
    "expires_at": "2025-01-01T00:00:00Z"
  },
  "user": { "user_id": "user-test-123" },
  "reset_sessions": false,
  "oauth_user_registration_id": "oauth-reg-123",
  "user_session": null,
  "user_device": null
}
```

### Error Handling
- **400 Bad Request**: Invalid or missing parameters (e.g., missing `token`).
- **401 Unauthorized**: Invalid or expired OAuth token.
- **404 Not Found**: Provider not supported or user not found.
- **500 Internal Server Error**: Unexpected server error.

### Notes
- The `attach` method returns an `AttachResponse` containing a single-use `oauth_attach_token` used to link the OAuth flow to a Stytch User selection.
- The `authenticate` method returns an `AuthenticateResponse` with user and session details.
- Both methods have `_async` variants with the same return types.
- PKCE is supported by passing a `code_verifier` to `authenticate` after starting the flow with `attach`.

### See also

- [B2B OAuth (in the B2B docs)](./b2b-sso.md)
- [IDP / token introspection](./shared-utilities.md)
```

--------------------------------

### SyncClient.get

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/core-http-client.md

Performs an HTTP GET request with basic auth, returning a ResponseWithJson wrapping the requests.Response and parsed JSON body.

```APIDOC
## [GET] (SyncClient.get)

### Description
Performs an HTTP GET request using the synchronous client. The `params` argument is passed as the query string. Basic auth and default headers are applied automatically.

### Method
GET

### Parameters
#### Query Parameters
- **params** (Dict[str, Any]) - Optional - Query string parameters to append to the URL.
- **headers** (Dict[str, str]) - Optional - Additional headers merged with the default `Content-Type: application/json` and `User-Agent` headers.

### Response
#### Success Response (200)
- **response** (requests.Response) - The underlying `requests.Response` object.
- **json** (Dict[str, Any]) - Parsed JSON body (empty dict if parsing fails).

### Response Example
```json
{
  
```

```APIDOC
{
  "response": "<requests.Response>",
  "json": {} 
}
```

--------------------------------

### Other Member Methods

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-organizations.md

Additional member operations including reactivate, delete MFA phone number, delete TOTP, delete password, dangerously get, OIDC providers, unlink retired email, start email update, get connected apps, and delete external ID.

```APIDOC
## PUT /v1/b2b/organizations/{organization_id}/members/{member_id}/reactivate

### Description
Reactivates a previously deactivated member.

### Method
PUT

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/reactivate`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member to reactivate.

### Response
#### Success Response (200)
- **member** (object) - The reactivated member object.

---

## DELETE /v1/b2b/organizations/{organization_id}/members/mfa_phone_numbers/{member_id}

### Description
Deletes the MFA phone number for a member.

### Method
DELETE

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/mfa_phone_numbers/{member_id}`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

### Response
#### Success Response (200)
- **member** (object) - The updated member object.

---

## DELETE /v1/b2b/organizations/{organization_id}/members/{member_id}/totp

### Description
Deletes the TOTP enrollment for a member.

### Method
DELETE

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/totp`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

### Response
#### Success Response (200)
- **member** (object) - The updated member object.

---

## DELETE /v1/b2b/organizations/{organization_id}/members/passwords/{member_password_id}

### Description
Deletes a member's password.

### Method
DELETE

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/passwords/{member_password_id}`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_password_id** (string) - Required - The ID of the member password to delete.

### Response
#### Success Response (200)
- **member_id** (string) - The ID of the member.

---

## GET /v1/b2b/organizations/members/dangerously_get/{member_id}

### Description
Retrieves a member by ID without requiring organization_id. This is a dangerous operation.

### Method
GET

### Endpoint
`/v1/b2b/organizations/members/dangerously_get/{member_id}`

### Parameters
#### Path Parameters
- **member_id** (string) - Required - The ID of the member.

#### Query Parameters
- **include_deleted** (boolean) - Optional - Whether to include deleted members.

### Response
#### Success Response (200)
- **member** (object) - The member object.

---

## GET /v1/b2b/organizations/{organization_id}/members/{member_id}/oidc_providers

### Description
Retrieves the OIDC providers linked to a member.

### Method
GET

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/oidc_providers`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

#### Query Parameters
- **include_refresh_token** (boolean) - Optional - Whether to include refresh tokens.

### Response
#### Success Response (200)
- **oidc_providers** (array of objects) - List of OIDC providers.

---

## POST /v1/b2b/organizations/{organization_id}/members/{member_id}/unlink_retired_email

### Description
Unlinks a retired email address from a member.

### Method
POST

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/unlink_retired_email`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

#### Request Body
- **email_id** (string) - Optional - The ID of the retired email.
- **email_address** (string) - Optional - The retired email address.

### Response
#### Success Response (200)
- **member** (object) - The updated member object.

---

## POST /v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update

### Description
Starts an email update flow for a member.

### Method
POST

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

#### Request Body
- **email_address** (string) - Required - The new email address.
- **login_redirect_url** (string) - Optional - Redirect URL after login.
- **locale** (string) - Optional - Locale for the email.
- **login_template_id** (string) - Optional - Template ID for the login email.
- **delivery_method** (string) - Optional - Delivery method for the email.

### Response
#### Success Response (200)
- **member** (object) - The updated member object.
- **email_delivery** (object) - Email delivery details.

---

## GET /v1/b2b/organizations/{organization_id}/members/{member_id}/connected_apps

### Description
Retrieves the connected apps for a member.

### Method
GET

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/connected_apps`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

### Response
#### Success Response (200)
- **connected_apps** (array of objects) - List of connected apps.

---

## DELETE /v1/b2b/organizations/{organization_id}/members/{member_id}/external_id

### Description
Deletes the external ID associated with a member.

### Method
DELETE

### Endpoint
`/v1/b2b/organizations/{organization_id}/members/{member_id}/external_id`

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The ID of the organization.
- **member_id** (string) - Required - The ID of the member.

### Response
#### Success Response (200)
- **member** (object) - The updated member object.
```

--------------------------------

### get method signature

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-sessions.md

Signature for the `get` method. It retrieves member sessions for a given organization and member. Route: `GET /v1/b2b/sessions`. Returns `GetResponse` with `member_sessions`.

```python
def get(self, organization_id: str, member_id: str) -> GetResponse:
```

--------------------------------

### get

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-organizations.md

Retrieves an organization by its ID. Sends a GET request to /v1/b2b/organizations/{organization_id}.

```APIDOC
## GET /v1/b2b/organizations/{organization_id}

### Description
Retrieves an organization by its unique ID.

### Method
GET

### Endpoint
/v1/b2b/organizations/{organization_id}

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique ID of the organization.

### Response
#### Success Response (200)
Returns a GetResponse object containing the organization details.

```

--------------------------------

### GET /v1/b2b/sessions

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves a B2B session.

```APIDOC
## GET /v1/b2b/sessions

### Description
Retrieves a B2B session.

### Method
GET

### Endpoint
/v1/b2b/sessions

### Response
#### Success Response
- **GetResponse** - The response object.
```

--------------------------------

### Import and instantiate stytch.B2BClient

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-client.md

Shows how to import the Stytch Python SDK and create a B2B client instance with your project ID and secret. The client is the entry point for Stytch's B2B API.

```python
import stytch

client = stytch.B2BClient(
    project_id="project-live-...",
    secret="secret-live-...",
)

```

--------------------------------

### GET /v1/rbac/policy

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves the RBAC policy.

```APIDOC
## GET /v1/rbac/policy

### Description
Retrieves the RBAC policy.

### Method
GET

### Endpoint
/v1/rbac/policy

### Response
#### Success Response
- **PolicyResponse** - The response object.
```

--------------------------------

### GET /v1/projects/metrics

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves project metrics.

```APIDOC
## GET /v1/projects/metrics

### Description
Retrieves project metrics.

### Method
GET

### Endpoint
/v1/projects/metrics

### Response
#### Success Response
- **MetricsResponse** - The response object.
```

--------------------------------

### Import and instantiate stytch.Client

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-client.md

Shows the package-level import and construction of the consumer client with project_id and secret. Use this to create the primary entry point for Stytch's Consumer API.

```python
import stytch

client = stytch.Client(
    project_id="project-live-...",
    secret="secret-live-...",
)
```

--------------------------------

### Basic initialization and magic link flow

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-client.md

Initializes the Stytch client with project and secret keys, then performs a sync magic link login_or_create call. The same client object also supports async variants, as shown by the async flow function.

```python
import stytch

client = stytch.Client(
    project_id="project-live-c60c0abe-c25a-4472-a9ed-320c6667d317",
    secret="secret-live-80JASucyk7z_G8Z-7dVwZVGXL5NT_qGAQ2I=",
)

# Sync call
resp = client.magic_links.email.login_or_create(
    email="sandbox@stytch.com",
    login_magic_link_url="https://example.com/authenticate",
)

# The same client object also supports async variants
async def flow():
    resp = await client.magic_links.email.login_or_create_async(
        email="sandbox@stytch.com",
    )
    return resp

```

--------------------------------

### GET /v1/b2b/sessions/jwks/{project_id}

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves JWKS for a project.

```APIDOC
## GET /v1/b2b/sessions/jwks/{project_id}

### Description
Retrieves JWKS for a project.

### Method
GET

### Endpoint
/v1/b2b/sessions/jwks/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.

### Response
#### Success Response
- **GetJWKSResponse** - The response object.
```

--------------------------------

### GET /v1/sessions

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-sessions.md

Retrieves all sessions for a user by their user_id.

```APIDOC
## GET /v1/sessions

### Description
Retrieves a list of sessions for a given user.

### Method
GET

### Endpoint
/v1/sessions

### Parameters
#### Query Parameters
- **user_id** (string) - Required - The ID of the user whose sessions to retrieve.

### Response
#### Success Response (200)
- **sessions** (List[Session]) - List of session objects.

#### Response Example
{
  "sessions": []
}
```

--------------------------------

### Initialize SamlShieldClient with public_token

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/samlshield-client.md

Import the stytch package and instantiate the SamlShieldClient with a public token. This client is standalone and uses Bearer authentication with the provided public token. The public token is required and must be a string; an empty string raises a ValueError.

```python
import stytch

client = stytch.SamlShieldClient(public_token="saml-public-...")

```

--------------------------------

### Password create, authenticate, migrate, and strength check

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-passwords.md

Demonstrates common password operations: creating and authenticating a user to obtain a session token, migrating a bcrypt hash, and performing a strength check. Each method returns a typed response, and the strength check provides feedback suggestions when available.

```python
# Create + authenticate
created = client.passwords.create(email="a@b.com", password="hunter2hunter2")
resp = client.passwords.authenticate(
    email="a@b.com",
    password="hunter2hunter2",
    session_duration_minutes=60,
)
print(resp.session_token)

# Migrate a bcrypt hash
client.passwords.migrate(
    email="a@b.com",
    hash="$2a$12$...",
    hash_type="bcrypt",
)

# Strength check
check = client.passwords.strength_check(password="hunter2hunter2")
if check.feedback is not None:
    print(check.feedback.suggestions)
```

--------------------------------

### GET /v1/b2b/organizations/{organization_id}/member

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves a member of an organization.

```APIDOC
## GET /v1/b2b/organizations/{organization_id}/member

### Description
Retrieves a member of an organization.

### Method
GET

### Endpoint
/v1/b2b/organizations/{organization_id}/member

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The organization ID.

### Response
#### Success Response
- **GetResponse** - The response object.
```

--------------------------------

### GET /v1/debug/whoami

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Returns information about the current API caller.

```APIDOC
## GET /v1/debug/whoami

### Description
Returns information about the current API caller.

### Method
GET

### Endpoint
/v1/debug/whoami

### Response
#### Success Response
- **WhoamiResponse** - The response object.
```

--------------------------------

### Create an organization and send a login/signup magic link

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-client.md

Initializes a B2BClient with project credentials, creates an organization with allowed domains, and sends a login/signup magic link to a member email. The organization ID from the creation response is used in the magic link request.

```python
import stytch

client = stytch.B2BClient(
    project_id="project-live-...",
    secret="secret-live-...",
)

org = client.organizations.create(
    organization_name="Acme Co",
    organization_slug="acme-co",
    email_allowed_domains=["acme.co"],
)

resp = client.magic_links.email.login_or_signup(
    organization_id=org.organization.organization_id,
    email_address="admin@acme.co",
    login_redirect_url="https://example.com/authenticate",
)
```

--------------------------------

### GET /v1/m2m/clients/{client_id}

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves an M2M client by ID.

```APIDOC
## GET /v1/m2m/clients/{client_id}

### Description
Retrieves an M2M client by ID.

### Method
GET

### Endpoint
/v1/m2m/clients/{client_id}

### Parameters
#### Path Parameters
- **client_id** (string) - Required - The client ID.

### Response
#### Success Response (200)
- **GetResponse** - The response object.

```

--------------------------------

### GET /v1/b2b/sessions

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-sessions.md

Retrieves all active sessions for a member in an organization.

```APIDOC
## [GET] /v1/b2b/sessions

### Description
Retrieves all active sessions for a member in an organization.

### Method
GET

### Endpoint
/v1/b2b/sessions

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The organization ID of the member.
- **member_id** (string) - Required - The member ID whose sessions to retrieve.

### Response
#### Success Response (200)
- **member_sessions** (List[MemberSession]) - List of member sessions.

#### Response Example
{
  "member_sessions": []
}
```

```APIDOC
## [GET] /v1/b2b/sessions

### Description
Retrieves all active sessions for a given member in an organization.

### Method
GET

### Endpoint
/v1/b2b/sessions

### Parameters
#### Query Parameters
- **organization_id** (string) - Required - The organization ID of the member.
- **member_id** (string) - Required - The member ID whose sessions to retrieve.

### Request Example
GET /v1/b2b/sessions?organization_id=org-123&member_id=member-456

### Response
#### Success Response (200)
- **member_sessions** (array of MemberSession) - List of active member sessions.

#### Response Example
{
  "member_sessions": []
}
```

```APIDOC
## [POST] /v1/b2b/sessions/authenticate

### Description
Authenticates a B2B member session using a session token or JWT, with optional authorization checks.

### Method
POST

### Endpoint
/v1/b2b/sessions/authenticate

### Parameters
#### Request Body
- **session_token** (string) - Optional - The session token to authenticate.
- **session_duration_minutes** (integer) - Optional - The session duration in minutes.
- **session_jwt** (string) - Optional - The session JWT to authenticate.
- **session_custom_claims** (object) - Optional - Custom claims to add to the session.
- **authorization_check** (object) - Optional - B2B AuthorizationCheck with organization_id, resource_id, action. Throws 403 if member is not authorized.

### Request Example
{
  "session_token": "example_token",
  "session_duration_minutes": 60,
  "session_jwt": "example_jwt",
  "session_custom_claims": {},
  "authorization_check": {
    "organization_id": "org-123",
    "resource_id": "resource-123",
    "action": "read"
  }
}

### Response
#### Success Response (200)
- **member_session** (object) - The authenticated member session.
- **member** (object) - The member associated with the session.
- **organization** (object) - The organization associated with the session.
- **verdict** (object, optional) - Authorization verdict when authorization_check is provided.

#### Response Example
{
  "member_session": {},
  "member": {},
  "organization": {},
  "verdict": {}
}
```

--------------------------------

### stytch.Client constructor

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-client.md

Creates a new consumer client instance with the provided project ID and secret. Additional optional parameters allow customization of environment, sessions, and base URLs.

```APIDOC
## stytch.Client

### Description
Creates a new consumer client instance for the Stytch Consumer API.

### Method
Constructor

### Signature
```python
def __init__(
    self,
    project_id: str,
    secret: str,
    environment: Optional[str] = None,
    suppress_warnings: bool = False,
    sync_session: Optional[requests.Session] = None,
    async_session: Optional[aiohttp.ClientSession] = None,
    fraud_environment: Optional[str] = None,
    custom_base_url: Optional[str] = None,
):
```

### Parameters
- **project_id** (str) - Required - The Stytch project ID (e.g. `project-live-...`). Used for basic auth and for building the JWKS URL.
- **secret** (str) - Required - The Stytch API secret. Used for HTTP basic auth.
- **environment** (Optional[str]) - Optional - `"test"`, `"live"`, or a custom URL. `"test"` resolves to `https://test.stytch.com/`, `"live"` to `https://api.stytch.com/`. Any other string is used verbatim as the base URL. Defaults to inferred from `project_id` (`live` if the ID starts with `project-live-`, else `test`).
- **suppress_warnings** (bool) - Optional - Suppresses the "Test version of Stytch not intended for production use" warning and the environment/custom_base_url conflict warning. Defaults to `False`.
- **sync_session** (Optional[requests.Session]) - Optional - An existing `requests.Session` to use for synchronous HTTP calls. If omitted, one is created lazily.
- **async_session** (Optional[aiohttp.ClientSession]) - Optional - An existing `aiohttp.ClientSession` to use for asynchronous calls. If omitted, one is created lazily and owned (closed) by the client.
- **fraud_environment** (Optional[str]) - Optional - Base URL for the Fraud/telemetry API used by the `fraud` sub-client. Defaults to `https://telemetry.stytch.com`.
- **custom_base_url** (Optional[str]) - Optional - Overrides the base URL for all API calls. Must use the `https://` scheme (else `ValueError`); a trailing `/` is appended if missing. Takes precedence over `environment`.

### Validation / Warnings
- If `custom_base_url` is set and does not start with `https://`, `ValueError` is raised.
- If both `environment` and `custom_base_url` are provided, a `UserWarning` is emitted unless `suppress_warnings` is true.
- If `environment == "test"` (or inferred test) and `suppress_warnings` is false, a `UserWarning` is emitted.

### Example
```python
import stytch

client = stytch.Client(
    project_id="project-live-...",
    secret="secret-live-...",
)
```
```

--------------------------------

### GET /v1/b2b/sso/{organization_id}

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/b2b-sso.md

Returns all SAML/OIDC connections for the organization.

```APIDOC
## GET /v1/b2b/sso/{organization_id}

### Description
Returns all SAML/OIDC connections for the organization.

### Method
GET

### Endpoint
/v1/b2b/sso/{organization_id}

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The organization ID.

### Response
#### Success Response (200)
Returns a GetConnectionsResponse object containing the list of connections.

```

--------------------------------

### Import SyncClient, AsyncClient, ResponseWithJson

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/core-http-client.md

Import the HTTP client classes and the response wrapper from the stytch core HTTP module.

```python
from stytch.core.http.client import SyncClient, AsyncClient, ResponseWithJson
```

--------------------------------

### GET /v1/connected_apps/clients/{client_id}

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/endpoints.md

Retrieves a connected app client by ID.

```APIDOC
## GET /v1/connected_apps/clients/{client_id}

### Description
Retrieves a connected app client by ID.

### Method
GET

### Endpoint
/v1/connected_apps/clients/{client_id}

### Parameters
#### Path Parameters
- **client_id** (string) - Required - The client ID.

### Response
#### Success Response (200)
- **GetResponse** - The response object.

```

--------------------------------

### GET /v1/users/{user_id}/connected_apps

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-users.md

Retrieves the connected apps for a user.

```APIDOC
## GET /v1/users/{user_id}/connected_apps

### Description
Retrieves the connected apps for a user.

### Method
GET

### Endpoint
/v1/users/{user_id}/connected_apps

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The unique ID of the user.

### Response
#### Success Response (200)
- **connected_apps** (array) - List of connected apps.

```

--------------------------------

### ClientBase constructor

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/core-http-client.md

Base class for both sync and async clients. Stores the project ID and secret, and sets the default headers.

```python
class ClientBase:
    def __init__(self, project_id: str, secret: str) -> None:
        self.headers = HEADERS
        self.project_id = project_id
        self.secret = secret
```

--------------------------------

### Import path for client.users

Source: https://github.com/stytchauth/stytch-python/blob/main/_autodocs/api-reference/consumer-users.md

Shows how to access the Users API client from the Stytch Python SDK.

```python
client.users   # stytch.consumer.api.users.Users
```
Tokens:
Raw