@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/organization-domain.mdx

@@ -1,189 +0,0 @@
----
-descriptions:
-  legacy_organization_domain:
-    id: Unique identifier for the Organization Domain.
-    domain: Domain for the Organization Domain.
-    object: Distinguishes the Organization Domain object.
-    organization_id: The ID of the Organization associated with the Organization Domain.
-    state: >
-      The verification state of the Organization Domain.
-
-
-      A “pending” state means the Organization Domain has not been verified yet.
-
-      For example, the organization that owns the domain may need to set a DNS
-      record to verify ownership.
-
-
-      If DNS verification fails, the Organization Domain moves to a “failed”
-      state.
-
-
-      Once ownership has been verified, the OrganizationDomain moves to a
-      “verified” state.
-
-
-      The “legacy verified” state is being phased out, and is used for
-      organizations that have not yet transitioned to the current domain-policy
-      flow.
-    verification_strategy: >
-      How the Organization Domain was verified.
-
-
-      - `dns` means the Organization admin set a DNS record (based on the value
-      of `verification_token`) to prove ownership.
-
-      - `manual` indicates the domain was verified manually via the API or the
-      Dashboard.
-    verification_token: >-
-      When the verification strategy is `dns`, this token must be present in a
-      DNS record to verify the Organization Domain.
-reference:
-  curl:
-    - url: /reference/organization-domain
-      key: legacy_organization_domain
-      id: legacy_organization_domain
-      title: organization_domain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: string
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: string
-          description: (legacy_organization_domain.domain)
-        - key: organization_id
-          type: string
-          description: (legacy_organization_domain.organization_id)
-        - key: state
-          type: '"verified" | "pending" | "failed" | "legacy_verified"'
-          description: (legacy_organization_domain.state)
-        - key: verification_strategy
-          type: '"manual" | "dns"'
-          description: (legacy_organization_domain.verification_strategy)
-        - key: verification_token?
-          type: string
-          description: (legacy_organization_domain.verification_token)
-  js:
-    - url: /reference/organization-domain
-      key: LegacyOrganizationDomain
-      id: legacy_organization_domain
-      title: interface OrganizationDomain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: string
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: string
-          description: (legacy_organization_domain.domain)
-  go:
-    - url: /reference/organization-domain
-      key: LegacyOrganizationDomain
-      id: legacy_organization_domain
-      title: organizations.OrganizationDomain
-      properties:
-        - key: ID
-          type: string
-          description: (legacy_organization_domain.id)
-        - key: Domain
-          type: string
-          description: (legacy_organization_domain.domain)
-  java:
-    - url: /reference/organization-domain
-      key: LegacyOrganizationDomain
-      id: legacy_organization_domain
-      title: class OrganizationDomain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: String
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: String
-          description: (legacy_organization_domain.domain)
-  python:
-    - url: /reference/organization-domain
-      key: legacy_organization_domain
-      id: legacy_organization_domain
-      title: OrganizationDomain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: str
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: str
-          description: (legacy_organization_domain.domain)
-  ruby:
-    - url: /reference/organization-domain
-      key: legacy_organization_domain
-      id: legacy_organization_domain
-      title: Hash organization_domain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: String
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: String
-          description: (legacy_organization_domain.domain)
-  php:
-    - url: /reference/organization-domain
-      key: legacy_organization_domain
-      id: legacy_organization_domain
-      title: $organizationDomain
-      properties:
-        - key: object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: id
-          type: string
-          description: (legacy_organization_domain.id)
-        - key: domain
-          type: string
-          description: (legacy_organization_domain.domain)
-  dotnet:
-    - url: /reference/organization-domain
-      key: LegacyOrganizationDomain
-      id: legacy_organization_domain
-      title: class OrganizationDomain
-      properties:
-        - key: Object
-          type: '"organization_domain"'
-          description: (legacy_organization_domain.object)
-        - key: Id
-          type: string
-          description: (legacy_organization_domain.id)
-        - key: Domain
-          type: string
-          description: (legacy_organization_domain.domain)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/organization-domain.mdx
----
-
-## Organization Domain
-
-An Organization Domain (also known as a User Email Domain) represents an [Organization](/reference/organization)'s domain.
-
-These domains restrict which email addresses are able to sign in through SAML Connections when [allow profiles outside organization](/reference/organization) is `false`. This is the default behavior for Organizations. See [SSO frequently asked questions](/sso/launch-checklist/frequently-asked-questions) for more details on this behavior.
-
-Organization domains can be verified manually (through the API or the Dashboard), or through [a self-serve flow](/domain-verification) through the Admin Portal.
-The organization that defines this domain policy exerts authentication policy control over that domain across your application.
-For this reason, it is important to verify ownership of manually added domains.
-Additionally, WorkOS does not allow addition of common consumer domains, like `gmail.com`.
-
-<CodeBlock
-  title="Example Organization Domain"
-  file="organization-domain"
-  referenceId="legacy_organization_domain"
-/>

package/.docs/organized/docs/reference/rate-limits.mdx

@@ -1,50 +0,0 @@
----
-originalPath: .tmp-workos-clone/packages/docs/content/reference/rate-limits.mdx
----
-# Rate limits
-
-WorkOS APIs are rate limited to ensure that they are fast for everyone. If you find yourself getting 429 errors, double check your integration to make sure you aren’t making unnecessary requests.
-
-## General
-
-| Name         | Path | Limit                                        |
-| ------------ | ---- | -------------------------------------------- |
-| All requests | \*   | 6,000 requests per 60 seconds per IP address |
-
-This rate limits applies to all environments, staging and production. Exceptions to the general rate limit are listed below.
-
-## Single Sign-On
-
-| Name                                                          | Path           | Limit                                        |
-| ------------------------------------------------------------- | -------------- | -------------------------------------------- |
-| [Get Authorization URL](/reference/sso/get-authorization-url) | /sso/authorize | 1,000 requests per 60 seconds per connection |
-
-## Directory Sync
-
-| Name                                                        | Path             | Limit                               |
-| ----------------------------------------------------------- | ---------------- | ----------------------------------- |
-| [Directory Users](/reference/directory-sync/directory-user) | /directory_users | 4 requests per second per directory |
-
-## User Management
-
-Rate limiting for User Management APIs are enforced on an account basis.
-
-| Name                                                                | Path                                         | Limit                                                |
-| ------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------- |
-| Reads                                                               | /user_management/\*                          | 1,000 requests per 10 seconds                        |
-| Writes                                                              | /user_management/\*                          | 500 requests per 10 seconds                          |
-| [Authentication](/reference/user-management/authentication)         | /user_management/authenticate                | 10 requests per 60 seconds per email or challenge ID |
-| [Magic Auth](/reference/user-management/magic-auth)                 | /user_management/magic_auth/send             | 3 requests per 60 seconds per email                  |
-| [Email verification](/reference/user-management/email-verification) | /user_management/:id/email_verification/send | 3 requests per 60 seconds per user                   |
-| [Password reset](/reference/user-management/password-reset)         | /user_management/password_reset/send         | 3 requests per 60 seconds per email                  |
-
-## Hosted AuthKit
-
-| Name                     | Limits                                                     |
-| ------------------------ | ---------------------------------------------------------- |
-| Reads                    | 1,000 requests per 10 seconds                              |
-| Writes                   | 500 requests per 10 seconds                                |
-| SSO sign-ins             | 3 requests per 60 seconds per IP address                   |
-| Email sign-ins           | 10 requests per 60 seconds per email and IP address        |
-| Magic Auth sign-ins      | 10 requests per 60 seconds per IP address and challenge ID |
-| Magic Auth code requests | 3 requests per 60 seconds per IP address and email         |

package/.docs/organized/docs/reference/roles/list-for-organization.mdx

@@ -1,152 +0,0 @@
----
-descriptions:
-  list_organization_roles:
-    data: 'Array of [Roles](/reference/roles) ordered by priority.'
-    organization_id: The ID of the organization to list roles for.
-reference:
-  curl:
-    - key: list_organization_roles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: '/organizations/:organization_id/roles'
-      type: GET
-      returns:
-        - key: anonymous
-          type: object
-          unwrap: true
-          properties:
-            - key: data
-              type: array
-              description: (list_organization_roles.data)
-  js:
-    - key: listOrganizationRoles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: organizations.listOrganizationRoles()
-      returns:
-        - key: anonymous
-          type: object
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Role[]'
-              description: (list_organization_roles.data)
-  go:
-    - key: ListOrganizationRoles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: organizations.ListOrganizations()
-      parameters:
-        - (ctx)
-        - key: opts
-          type: organizations.ListOrganizationRolesOpts
-          expanded: true
-          properties:
-            - key: OrganizationId
-              type: string
-              description: (list_organization_roles.organization_id)
-      returns:
-        - key: list
-          type: organizations.ListOrganizationRolesResponse
-          expanded: true
-          properties:
-            - key: Data
-              type: '[]roles.Role'
-              description: (list_organization_roles.data)
-        - (err)
-  ruby:
-    - key: list_organization_roles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: Organizations.list_organization_roles()
-      parameters:
-        - key: organization_id
-          type: String
-          description: (list_organization_roles.organization_id)
-      returns:
-        - key: anonymous
-          type: Struct
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Array[Role]'
-              description: (list_organization_roles.data)
-  python:
-    - key: list_organization_roles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: organizations.list_organization_roles()
-      parameters:
-        - key: organization_id
-          type: str
-          description: (list_organization_roles.organization_id)
-      returns:
-        - key: anonymous
-          type: RoleList
-          unwrap: true
-          properties:
-            - key: data
-              type: 'list[Role]'
-              description: (list_organization_roles.data)
-  java:
-    - key: listOrganizationRoles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: organizations.listOrganizationRoles()
-      parameters:
-        - key: organizationId
-          type: String
-          description: (list_organization_roles.organization_id)
-      returns:
-        - key: anonymous
-          type: RoleList
-          expanded: true
-          properties:
-            - key: data
-              type: List<Role>
-              description: (list_organization_roles.data)
-  php:
-    - key: listOrganizationRoles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: $organizations->listOrganizationRoles()
-      parameters:
-        - key: organization_id
-          type: string
-          description: (list_organization_roles.organization_id)
-      returns:
-        - key: anonymous
-          type: array
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Role[]'
-              description: (list_organization_roles.data)
-  dotnet:
-    - key: ListOrganizationRoles
-      id: list_organization_roles
-      url: /reference/roles/list-for-organization
-      title: organizationsService.ListOrganizationRoles()
-      parameters:
-        - key: organizationId
-          type: string
-          description: (list_organization_roles.organization_id)
-      returns:
-        - key: Task<WorkOSList<Role>>
-          expanded: true
-          properties:
-            - key: Data
-              type: List<Role>
-              description: (list_organization_roles.data)
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/roles/list-for-organization.mdx
----
-
-## List roles for an organization
-
-Get a list of all roles for the provided organization in priority order. Includes all environment and organization roles.
-
-<CodeBlock referenceId="list_organization_roles">
-  <CodeBlockTab title="Request" file="list-organization-roles-request" />
-  <CodeBlockTab title="Response" file="list-organization-roles-response" />
-</CodeBlock>

package/.docs/organized/docs/reference/user-management/access-token/index.mdx

@@ -1,13 +0,0 @@
----
-descriptions:
-  access_token:
-    self: >-
-      The [access_token](/reference/user-management/access-token) for session
-      management.
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/access-token/index.mdx
----
-
----
-
-# Access Token

package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx

@@ -1,23 +0,0 @@
----
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx
----
-### Redirect URI
-
-In the [OAuth 2.0](/glossary/oauth-2-0) protocol, a redirect URI is the location that the user is redirected to once they have successfully authenticated with their identity provider.
-
-When redirecting the user, WorkOS will generate an authorization code and pass it to your redirect URI as a `code` query parameter, your app will use this code to [authenticate the user](/reference/user-management/authentication/code). Additionally, WorkOS can pass a `state` parameter back to your application that you may use to encode arbitrary information to restore your application state between the redirects.
-
-```url title="Redirect URI with query parameters"
-https://your-app.com/callback?code=01E2RJ4C05B52KKZ8FSRDAP23J&state=dj1kUXc0dzlXZ1hjUQ==
-```
-
-You can use `state` to encode parameters like originating URL and query parameters. This is useful in a flow where unauthenticated users are automatically redirected to a login page. After successful sign in, users will be routed to your redirect URI callback route. From there you can extract the originating URL from `state` and redirect the user to their intended destination.
-
-You’ll need to configure the allowed redirect URIs for your application via the [Redirects](https://dashboard.workos.com/redirects) page in the dashboard. Without a valid redirect URI, your users will be unable to sign in. Make sure that the redirect URI you use as a parameter to get the authorization URL matches one of the redirect URIs you have configured in the dashboard.
-
-Redirect URIs follow stricter requirements in production environments:
-
-- `HTTPS` protocol is required in production environments
-- `HTTP` and `localhost` are allowed in staging environments
-- Wildcard characters are not allowed in production environments

package/.docs/organized/docs/reference/user-management/index.mdx

@@ -1,13 +0,0 @@
----
-descriptions:
-  challenge_response:
-    token: The email verification token.
-    user: 'The corresponding [User](/reference/user-management/user) object.'
-originalPath: .tmp-workos-clone/packages/docs/content/reference/user-management/index.mdx
----
-
-# User Management
-
-A set of user authentication and organization security features designed to provide a fast, scalable integration while handling all of the user management complexity that comes with advanced business and customer needs.
-
-To automatically respond to User Management activities, like authentication and changes related to the users, use the corresponding [events](/events).

package/.docs/organized/docs/reference/user-management/mfa/index.mdx

@@ -1,5 +0,0 @@
----
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/mfa/index.mdx
----
-

package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx

@@ -1,5 +0,0 @@
----
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/index.mdx
----
-# Session tokens

package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx

@@ -1,8 +0,0 @@
----
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/refresh-token.mdx
----
-## Refresh token
-
-The refresh token can be used to obtain a new access token using the [authenticate with refresh token
-](reference/user-management/authentication/refresh-token) endpoint. Refresh tokens may only be used once. Refreshes will succeed as long as the user's session is still active.

package/.docs/organized/docs/user-management/_navigation.mdx

@@ -1,87 +0,0 @@
----
-title: User Management
-links:
-  - title: Getting Started
-    links:
-      - title: Quick Start
-        url: /user-management
-      - title: Example Apps
-        url: /user-management/example-apps
-  - title: Modeling Your App
-    links:
-      - title: Introduction and concepts
-        url: /user-management/modeling-your-app
-      - title: SSO with contractors
-        url: /user-management/sso-with-contractors
-      - title: Invite-only signup
-        url: /user-management/invite-only-signup
-  - title: Integrating
-    links:
-      - title: AuthKit
-        url: /user-management/authkit
-      - title: Branding
-        url: /user-management/branding
-      - title: Migrations
-        url: /user-management/migrations
-      - title: Widgets
-        url: /user-management/widgets
-      - title: Actions
-        url: /user-management/actions
-        featureFlag: actions-docs
-      - title: MCP
-        url: /user-management/mcp
-      - title: On-prem Deployment
-        url: /on-prem-deployment
-  - title: Authentication
-    links:
-      - title: Single Sign-On
-        url: /user-management/sso
-      - title: Email + Password
-        url: /user-management/email-password
-      - title: Passkeys
-        url: /user-management/passkeys
-      - title: Social Login
-        url: /user-management/social-login
-      - title: Multi-Factor Auth
-        url: /user-management/mfa
-      - title: Magic Auth
-        url: /user-management/magic-auth
-  - title: Features
-    links:
-      - title: Users and Organizations
-        url: /user-management/users-organizations
-      - title: Sessions
-        url: /user-management/sessions
-      - title: Radar
-        url: /user-management/radar
-      - title: Invitations
-        url: /user-management/invitations
-      - title: Email Verification
-        url: /user-management/email-verification
-      - title: Domain Verification
-        url: /user-management/domain-verification
-      - title: Identity Linking
-        url: /user-management/identity-linking
-      - title: JIT Provisioning
-        url: /user-management/jit-provisioning
-      - title: Roles and Permissions
-        url: /user-management/roles-and-permissions
-      - title: Directory Provisioning
-        url: /user-management/directory-provisioning
-      - title: Organization Policies
-        url: /user-management/organization-policies
-      - title: Impersonation
-        url: /user-management/impersonation
-      - title: Custom Emails
-        url: /user-management/custom-emails
-      - title: Entitlements
-        url: /user-management/entitlements
-      - title: Metadata and External IDs
-        url: /user-management/metadata
-      - title: JWT Templates
-        url: /user-management/jwt-templates
-      - title: Connect
-        url: /user-management/connect
-originalPath: .tmp-workos-clone/packages/docs/content/user-management/_navigation.mdx
----
-

package/.docs/organized/docs/user-management/authkit.mdx

@@ -1,69 +0,0 @@
----
-title: AuthKit
-description: >-
-  Customizable sign-in UI that abstracts away all of the complexity associated
-  with building secure authentication flows.
-showNextPage: true
-originalPath: .tmp-workos-clone/packages/docs/content/user-management/authkit.mdx
----
-
-## Introduction
-
-Implementing authentication flows that handle every possible error state and edge case across multiple identity providers can be a daunting task. AuthKit makes this easy by providing a hosted, pre-built, customizable authentication UI with automatic handling of:
-
-- Sign up, sign in, password reset, and [email verification](/user-management/email-verification) flows.
-- Enterprise [SSO](/user-management/sso) routing and [MFA](/user-management/mfa) enrollment.
-- Automatic bot detection and blocking, to protect against brute force attacks.
-- Customizable [domain](/custom-domains/authkit) and [branding](/user-management/branding).
-
-![AuthKit sign-in UI](https://images.workoscdn.com/images/4d736ca3-eec8-4a90-bd14-2530c4210415.png?auto=format&fit=clip&q=80)
-
-## Authentication flow
-
-AuthKit is conceptually similar to a [Social Login (OAuth)](/user-management/social-login) experience, but with the added benefit of being able to authenticate users with any identity provider.
-
-AuthKit sits outside of your application code. When a user initiates a sign-in request, your application redirects them to the AuthKit URL. The user then completes the authentication process with WorkOS before being returned to the application.
-
-Your application will exchange the resulting authorization code to retrieve an authenticated [User object](/reference/user-management/user) and handle the session.
-
-![AuthKit authentication flow diagram](https://images.workoscdn.com/images/0b3265fa-a209-4ca7-beaf-7d2514a3e00a.png?auto=format&fit=clip&q=80)[border=false]
-
-> The AuthKit flow abstracts away many of the UX and WorkOS API calling concerns automatically, for more guidance on integrating with AuthKit, see the [Quick Start](/user-management) guide.
-
-AuthKit also provides a signup flow for creating users. Available options are determined by the configured [authentication methods](/user-management/authkit/authentication-methods). If a user’s email address is associated with an SSO connection, they will automatically be redirected to sign up via their IdP.
-
-## Authentication methods
-
-AuthKit supports all of the authentication methods available in WorkOS User Management and will automatically adjust the available options depending on the configured methods in the _Authentication_ section of the [WorkOS Dashboard](https://dashboard.workos.com).
-
-![Dashboard displaying available authentication methods](https://images.workoscdn.com/images/ea3b2c3b-723e-462c-aa10-6b1cec1b635f.png?auto=format&fit=clip&q=80)
-
-Email + Password authentication is enabled by default, though set up may be required to enable additional methods. See the relevant feature section for more information:
-
-- [Single Sign-On](/user-management/sso)
-- [Email + Password](/user-management/email-password)
-- [Social Login](/user-management/social-login)
-- [Multi-Factor Auth](/user-management/mfa)
-- [Magic Auth](/user-management/magic-auth)
-
-## Custom OAuth static scopes
-
-AuthKit offers support for custom OAuth static scopes for both Google and Microsoft integrations. This allows you to request specific permissions when accessing user profile data from these providers. For instance, requesting access to read Google Calendar events or retrieve emails from a Microsoft account.
-
-> This feature is currently available in a restricted preview. [Contact us](mailto:support@workos.com) for additional details.
-
----
-
-## Integrating
-
-Integration into your app is quick and easy, though the route you choose varies depending on your specific requirements:
-
-### (A) Integrate with AuthKit
-
-In just a few lines of code, you can add AuthKit to your app and start authenticating users. See the [quick start](/user-management) guide for more information.
-
-### (B) Build your own authentication flows
-
-While the hosted solution is the fastest way to get started, if you’d prefer to build and manage your own authentication UI, you can do so via the [User Management API](/reference/user-management).
-
-Examples of building custom UI are [available on GitHub](https://github.com/workos/authkit).