WorkOS Documentation llms.txt · AI Docs Browser · mdream
[llms.txt Tools](https://mdream.dev/llms-txt/workos/llms-txt)
# WorkOS Documentation llms.txt
Browse WorkOS Documentation documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.
docs.workos.com/llms.txt
[Raw llms.txt](https://docs.workos.com/llms.txt) [Raw llms-full.txt](https://docs.workos.com/llms-full.txt)
Copy Markdown [](https://docs.workos.com/llms.txt)
llms.txt
Getting started
Auth
Pricing
Pricing
Postman
WorkOS Postman collection
On prem deployment
Using WorkOS with On-prem Customers
Migrate standalone sso
Migrate from the standalone SSO API
Mcp
WorkOS MCP
Glossary
Glossary
Email
Email delivery
Widgets
User Sessions Widget
User Security Widget
User Profile Widget
User Management Widget
Authorization Tokens
Quick Start
Pipes Widget
Pipes Admin Widget
Organization Switcher Widget
Localization
WorkOS Widgets
Directory Sync Widget
Audit Log Streaming Widget
API Keys Widget
SSO Connection Widget
Domain Verification Widget
Theme Customization
Styling
CSS Customization
Vault
Quick Start
Key Context
Vault
Bring Your Own Key (BYOK)
Single Sign-On
Sdks
rust
ruby
python
php
node
laravel
java
go
elixir
dotnet
authkit-tanstack-start
authkit-remix
authkit-react
authkit-react-router
authkit-nextjs
authkit-js
authkit-astro
API Reference
API Reference
admin-portal
admin-portal - portal-link
admin-portal - portal-link - generate
admin-portal - provider-icons
agents
agents - get-registration
agents - validate-credential
api-authentication
audit-logs
audit-logs - configuration
audit-logs - event
audit-logs - event - create
audit-logs - export
audit-logs - export - create
audit-logs - export - get
audit-logs - retention
audit-logs - retention - get
audit-logs - retention - set
audit-logs - schema
audit-logs - schema - create
audit-logs - schema - list
audit-logs - schema - list-actions
authkit
authkit - agent-registration
authkit - agent-registration - claim
authkit - agent-registration - claim-complete
authkit - agent-registration - claim-view
authkit - agent-registration - register
authkit - api-keys
authkit - api-keys - create-for-organization
authkit - api-keys - create-for-user
authkit - api-keys - delete
authkit - api-keys - expire
authkit - api-keys - list-for-organization
authkit - api-keys - list-for-user
authkit - api-keys - validate
authkit - authentication
authkit - authentication-errors
authkit - authentication-errors - email-verification-required-error
authkit - authentication-errors - mfa-challenge-error
authkit - authentication-errors - mfa-enrollment-error
authkit - authentication-errors - organization-authentication-required-error
authkit - authentication-errors - organization-selection-error
authkit - authentication-errors - radar-email-challenge-error
authkit - authentication-errors - radar-sms-challenge-error
authkit - authentication-errors - sso-required-error
authkit - authentication - code
authkit - authentication - email-verification
authkit - authentication - get-authorization-url
authkit - authentication - get-authorization-url - error-codes
authkit - authentication - get-authorization-url - pkce
authkit - authentication - get-authorization-url - redirect-uri
authkit - authentication - magic-auth
authkit - authentication - organization-selection
authkit - authentication - password
authkit - authentication - radar-email-challenge
authkit - authentication - radar-sms-challenge
authkit - authentication - refresh-and-seal-session-data
authkit - authentication - refresh-token
authkit - authentication - session-cookie
authkit - authentication - totp
authkit - cli-auth
authkit - cli-auth - device-authorization
authkit - cli-auth - device-code
authkit - cli-auth - error-codes
authkit - create-cors-origin
authkit - create-user-data-installation
authkit - email-verification
authkit - email-verification - get
authkit - get
authkit - identity
authkit - identity - list
authkit - invitation
authkit - invitation - accept
authkit - invitation - find-by-token
authkit - invitation - get
authkit - invitation - list
authkit - invitation - resend
authkit - invitation - revoke
authkit - invitation - send
authkit - jwt-template
authkit - jwt-template - get
authkit - jwt-template - update
authkit - list-cors-origin
authkit - logout
authkit - logout - get-logout-url
authkit - logout - get-logout-url-from-session-cookie
authkit - magic-auth
authkit - magic-auth - create
authkit - magic-auth - get
authkit - mfa
authkit - mfa - authentication-challenge
authkit - mfa - authentication-factor
authkit - mfa - enroll-auth-factor
authkit - mfa - list-auth-factors
authkit - organization-membership
authkit - organization-membership - create
authkit - organization-membership - deactivate
authkit - organization-membership - delete
authkit - organization-membership - get
authkit - organization-membership - list
authkit - organization-membership - list-groups
authkit - organization-membership - reactivate
authkit - organization-membership - update
authkit - password-reset
authkit - password-reset - create
authkit - password-reset - get
authkit - password-reset - reset-password
authkit - redirect-uri
authkit - redirect-uri - create
authkit - redirect-uri - delete
authkit - redirect-uri - list
authkit - send-radar-sms-challenge
authkit - session
authkit - session-helpers
authkit - session-helpers - authenticate
authkit - session-helpers - get-logout-url
authkit - session-helpers - load-sealed-session
authkit - session-helpers - refresh
authkit - session-tokens
authkit - session-tokens - access-token
authkit - session-tokens - jwks
authkit - session-tokens - refresh-token
authkit - session - list
authkit - session - revoke
authkit - update-user-data-installation
authkit - user
authkit - user - authorized-application - delete
authkit - user - authorized-application - list
authkit - user - confirm-email-change
authkit - user - create
authkit - user - delete
authkit - user - email-verification
authkit - user - get
authkit - user - get-by-external-id
authkit - user - list
authkit - user - send-email-change
authkit - user - send-verification-email
authkit - user - update
client-libraries
client - issue
directory-sync
directory-sync - directory
directory-sync - directory-group
directory-sync - directory-group - get
directory-sync - directory-group - list
directory-sync - directory-user
directory-sync - directory-user - get
directory-sync - directory-user - list
directory-sync - directory-user - list-by-group
directory-sync - directory - delete
directory-sync - directory - get
directory-sync - directory - list
domain-verification
domain-verification - create
domain-verification - delete
domain-verification - get
domain-verification - verify
errors
events
events - list
feature-flags
feature-flags - flag
feature-flags - flag - disable
feature-flags - flag - enable
feature-flags - flag - get
feature-flags - flag - list
feature-flags - targeting
feature-flags - targeting - add
feature-flags - targeting - list-for-organization
feature-flags - targeting - list-for-user
feature-flags - targeting - remove
fga
fga - access-check
fga - access-check - check
fga - access-check - list-effective-permissions
fga - access-check - list-effective-permissions-by-external-id
fga - access-check - list-memberships
fga - access-check - list-memberships-by-external-id
fga - access-check - list-resources
fga - resource
fga - resource - create
fga - resource - delete
fga - resource - delete-by-external-id
fga - resource - get
fga - resource - get-by-external-id
fga - resource - list
fga - resource - update
fga - resource - update-by-external-id
fga - role-assignment
fga - role-assignment - create
fga - role-assignment - delete
fga - role-assignment - delete-by-id
fga - role-assignment - list
fga - role-assignment - list-for-resource
fga - role-assignment - list-for-resource-by-external-id
groups
groups - add-member
groups - create
groups - delete
groups - get
groups - list
groups - list-members
groups - remove-member
groups - role-assignment
groups - role-assignment - create
groups - role-assignment - get
groups - role-assignment - list
groups - role-assignment - remove-group-role-assignment
groups - role-assignment - remove-group-role-assignments
groups - role-assignment - replace-group-role-assignments
groups - update
magic-link
magic-link - passwordless-session
magic-link - passwordless-session - create
magic-link - passwordless-session - send-email
mfa
mfa - challenge
mfa - challenge - create
mfa - challenge - verify
mfa - factor
mfa - factor - delete
mfa - factor - enroll
mfa - factor - get
organization
organization - create
organization - delete
organization - get
organization - get-by-external-id
organization - list
organization - update
pagination
pipes
pipes - access-token
pipes - access-token - get
pipes - access-token - vend-credentials
pipes - connected-account
pipes - connected-account - create
pipes - connected-account - delete
pipes - connected-account - get
pipes - connected-account - get-authorize-url
pipes - connected-account - update
pipes - connected-account - upsert-api-key
pipes - data-integration
pipes - data-integration - create
pipes - data-integration - delete
pipes - data-integration - get
pipes - data-integration - list
pipes - data-integration - update
pipes - provider
pipes - provider - configure
pipes - provider - list
pipes - provider - list-for-organization
radar
radar - attempts
radar - attempts - create
radar - attempts - update
radar - lists
radar - lists - delete
radar - lists - update
rate-limits
roles
roles - custom-role
roles - custom-role - add-permission
roles - custom-role - create
roles - custom-role - delete
roles - custom-role - get
roles - custom-role - list
roles - custom-role - remove-permission
roles - custom-role - set-permissions
roles - custom-role - update
roles - permission
roles - permission - create
roles - permission - delete
roles - permission - get
roles - permission - list
roles - permission - update
roles - role
roles - role - add-permission
roles - role - create
roles - role - get
roles - role - list
roles - role - set-permissions
roles - role - update
sso
sso - connection
sso - connection - delete
sso - connection - get
sso - connection - list
sso - get-authorization-url
sso - get-authorization-url - error-codes
sso - get-authorization-url - redirect-uri
sso - json-web-key-set
sso - logout
sso - logout - authorize
sso - logout - redirect
sso - profile
sso - profile - get-profile-and-token
sso - profile - get-user-profile
testing
vault
vault - key
vault - key - create-data-key
vault - key - decrypt-data
vault - key - decrypt-data-key
vault - key - encrypt-data
vault - key - rekey-data-key
vault - object
vault - object - create
vault - object - delete
vault - object - get
vault - object - get-by-name
vault - object - list
vault - object - metadata
vault - object - update
vault - object - version
vault - object - versions
webhooks
webhooks - create
webhooks - delete
webhooks - list
webhooks - update
widgets
widgets - get-token
workos-connect
workos-connect - applications
workos-connect - applications - client-secrets
workos-connect - applications - client-secrets - create
workos-connect - applications - client-secrets - delete
workos-connect - applications - client-secrets - list
workos-connect - applications - create
workos-connect - applications - delete
workos-connect - applications - get
workos-connect - applications - list
workos-connect - applications - m2m
workos-connect - applications - oauth
workos-connect - applications - update
workos-connect - authorize
workos-connect - cli-auth
workos-connect - cli-auth - authorize-device
workos-connect - cli-auth - device-code-grant
workos-connect - introspection
workos-connect - metadata
workos-connect - metadata - oauth-authorization-server
workos-connect - metadata - openid-configuration
workos-connect - standalone
workos-connect - standalone - complete
workos-connect - standalone - user-consent-options
workos-connect - token
workos-connect - token - authorization-code-grant
workos-connect - token - authorization-code-grant - access-token
workos-connect - token - authorization-code-grant - id-token
workos-connect - token - client-credentials-grant
workos-connect - token - client-credentials-grant - access-token
workos-connect - token - refresh-token-grant
workos-connect - userinfo
RBAC
Quick Start
Integrating Role-Based Access Control
Role-Based Access Control (RBAC)
IdP Role Assignment
Custom Roles
Configuration
Pipes
Providers
Organization-scoped providers
Pipes
Custom providers
API key providers
Migrations
Migrate from Supabase Auth
Migrate from Stytch
Migrate from other services
Migrate from Firebase
Migrate from Descope
Migrate from Clerk
Migrate from Better Auth
Migrate from AWS Cognito
Migrate from Auth0
Multi-Factor Auth
Multi-Factor Authentication
Example Apps
Sign-In UX
Enrollment UX
Magic Link
Launch Checklist
Magic Link
Example Apps
Integrations
Xero OAuth
Workday
VMware
Vercel OAuth
Supabase + WorkOS SSO
Supabase + AuthKit
Slack OAuth
SimpleSAMLphp
Shibboleth Unsolicited SAML
Shibboleth Generic SAML
SFTP
SCIM
SAML
Salesforce SAML
Salesforce OAuth
SailPoint SCIM
Rippling SCIM
Rippling SAML
React Native Expo
PingOne SAML
PingFederate SCIM
PingFederate SAML
Oracle SAML
OneLogin SCIM
OneLogin SAML
Okta SCIM
Okta SAML
Okta OIDC
OpenID Connect
NextAuth.js
NetIQ
miniOrange
Microsoft OAuth
Microsoft AD FS SAML
Login.gov OpenID Connect
LinkedIn OAuth
LastPass
Keycloak
JumpCloud SCIM
JumpCloud SAML
Intuit OAuth
HiBob
Google SAML
Google OIDC
Google OAuth
Google Directory Sync
GitLab OAuth
GitHub OAuth
Fourth
Firebase
Entra ID SCIM (formerly Azure AD)
Entra ID SAML (formerly Azure AD)
Entra ID OIDC (formerly Azure AD)
Duo
CyberArk SCIM
CyberArk SAML
Cloudflare
Clever OIDC
ClassLink
Cezanne HR
CAS SAML
Bubble Plugin
Breathe HR
BambooHR
AWS Cognito
Auth0
Auth0 Enterprise Connection
Auth0 Directory Sync
Apple
ADP OpenID Connect
Access People HR
FGA
Standalone Integration
Roles and Permissions
Resources
Resource Types
Resource Discovery
Quick Start
Share Button
Multi-level Inheritance
High-Cardinality Data
Basic App
Protecting API Endpoints
Migrate from SpiceDB
Migrate from Oso Cloud
Migrate from OpenFGA
Fine-Grained Authorization (FGA)
IdP Role Assignment
High-Cardinality Entities
AuthKit Integration
Role Assignments
Access Checks
Feature Flags
Slack Notifications
SDK Integration
Feature Flags
Events
Events
Stream events to Datadog
Sync data with webhooks
Data syncing
Sync data using the events API
Data reconciliation
Domain Verification
Domain Verification
API
Directory Sync
Understanding the Events Lifecycle
Quick Start
Directory Sync
Identity Provider Role Assignment
Handle Inactive Users
Example Apps
Unique Emails
User Attributes
Deprecations
Migrate from raw_attributes
Dashboard
Team settings
Members and roles
Dashboard
Billing
Team authentication
Custom Domains
Custom Domains
Email Domain
AuthKit Domain
Authentication API Domain
Admin Portal Domain
AuthKit
Waitlist
Users and Organizations
Single Sign-On
SSO with contractors
Social Login
Sessions
Roles and Permissions
AuthKit
Reauthentication
AuthKit
Radar
Radar Integration Guide
Projects
Pipes
Passkeys
AuthKit
Organization Authentication Policies
AuthKit
Modeling Your App
Migrating to AuthKit
Multi-Factor Authentication
Metadata and External IDs
Model Context Protocol
Magic Auth
Get started with AuthKit
JWT Templates
Just-in-time Provisioning
Invite-only signup
Invitations
Get started with AuthKit
Impersonation
Identity Linking
Hosted UI
Groups
Group Role Assignments
Example apps
Staging vs. production environments
Email Verification
Email + Password
Email Changes
Domain Verification
Directory Provisioning
Custom Emails
Custom Email Providers
Connect
AI Installer & CLI
CLI Auth
Branding
Applications
API Keys
API Gateway
Agent Registration
Actions
AuthKit
AuthKit
AuthKit
Standalone Connect
OAuth Applications
M2M Applications
Stripe
Segment
Google Analytics
Audit Logs
Metadata Schema
Log Streams
Audit Logs
Exporting Events
Editing Events
Admin Portal
Admin Portal
Bearer token rotation
Admin Portal
Example Apps
Custom Branding
## What is WorkOS Documentation's llms.txt?
WorkOS Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what WorkOS Documentation offers and where to find details.
Pass
Spec
30
Sections
625
Links
74.0 KB
Size
~18.9k
Tokens
Sections: Getting started · Pricing · Postman · On prem deployment · Migrate standalone sso · Mcp · and 24 more
## Add WorkOS Documentation Docs to Your AI Assistant
Select your tool to see how to add WorkOS Documentation's llms.txt as a documentation source.
Cursor
Windsurf
Claude Code
ChatGPT
Zed
Copilot
1. 1
Open any chat or composer panel
2. 2
Type @Docs and select "Add new doc"
3. 3
Paste the URL: https://docs.workos.com/llms.txt
4. 4
Wait for the green dot (indexing complete)
5. 5
Reference @Docs in chat when asking about WorkOS Documentation
Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.
## Spec Compliance 21 notes
## Frequently Asked Questions
Where is WorkOS Documentation's llms.txt file?
WorkOS Documentation publishes its llms.txt at https://docs.workos.com/llms.txt. This file provides a structured, markdown-formatted index of WorkOS Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references.
How do I use WorkOS Documentation's llms.txt with AI coding assistants?
Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of WorkOS Documentation's documentation so it can provide better code suggestions and answers about WorkOS Documentation.
What does WorkOS Documentation's llms.txt contain?
WorkOS Documentation's llms.txt contains 30 sections and 625 documentation links in 74.0 KB (~18.9k tokens). Key sections include Getting started, Pricing, Postman, On prem deployment, Migrate standalone sso, Mcp.
How many tokens does WorkOS Documentation's llms.txt use?
The concise llms.txt index is approximately 18.9k tokens (74.0 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.
What is WorkOS Documentation?
WorkOS provides developer-friendly APIs for enterprise features like Single Sign-On, Directory Sync, User Management, Admin Portal, Audit Logs, and more. This documentation site helps developers implement these features.. WorkOS Documentation's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with WorkOS Documentation.
Can I generate an llms.txt for my own project?
Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.
## Browse More llms.txt Files
[MCP Toolbox for Databases - Documentation Index MCP Toolbox for Databases is an open source MCP server for databases. It enables you to develop tools easier, faster, and more securely by handling the complexities such as connection pooling, authentication, and more.](https://mdream.dev/llms-txt/workos/llms-txt/genai-toolbox) [Fastify Fast and low overhead web framework, for Node.js](https://mdream.dev/llms-txt/workos/llms-txt/fastify) [Opik Documentation Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.](https://mdream.dev/llms-txt/workos/llms-txt/opik) [Unsloth Documentation Unsloth Studio is a web UI for training and running open models like Qwen, DeepSeek, gpt-oss and Gemma locally.](https://mdream.dev/llms-txt/workos/llms-txt/unsloth) [Ant Design - Enterprise-class React UI library An enterprise-class UI design language and React UI library](https://mdream.dev/llms-txt/workos/llms-txt/ant-design) [ElevenLabs Documentation](https://mdream.dev/llms-txt/workos/llms-txt/elevenlabs) [LiveKit docs LiveKit is a platform for building voice and realtime AI applications. LiveKit Cloud is the hosted commercial offering based on the open-source LiveKit project.](https://mdream.dev/llms-txt/workos/llms-txt/livekit) [DigitalOcean Documentation Comprehensive tutorials, references, example code, and more for DigitalOcean products.](https://mdream.dev/llms-txt/workos/llms-txt/digitalocean)
[View all 99 projects ](https://mdream.dev/llms-txt/workos/llms-txt)
## Related Tools
[llms.txt Generator
Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/workos/tools/llms-txt/generator) [llms.txt Validator
Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/workos/tools/llms-txt/validator)
© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)
[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)