@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/pipes/connected-account/delete.mdx

@@ -0,0 +1,42 @@
+---
+descriptions:
+  pipes_delete_connected_account:
+    user_id: 'A [User](/reference/authkit/user) identifier.'
+    slug: 'The slug identifier of the provider (e.g., `github`, `slack`, `notion`).'
+    organization_id: >-
+      An [Organization](/reference/organization) identifier. Optional parameter
+      if the connection is scoped to an organization.
+reference:
+  curl:
+    - key: pipes_delete_connected_account
+      id: pipes_delete_connected_account
+      url: /reference/pipes/connected-account/delete
+      title: '/user_management/users/:user_id/connected_accounts/:slug'
+      type: DELETE
+      parameters:
+        - key: user_id
+          type: string
+          description: (pipes_delete_connected_account.user_id)
+        - key: slug
+          type: string
+          description: (pipes_delete_connected_account.slug)
+        - key: organization_id
+          type: string
+          description: (pipes_delete_connected_account.organization_id)
+          optional: true
+      returns: []
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/pipes/connected-account/delete.mdx
+---
+
+## Delete a connected account
+
+Disconnects WorkOS's account for the user, including removing any stored access and refresh tokens. The user will need to reauthorize if they want to reconnect.
+
+This does not revoke access on the provider side. The user may need to disconnect the application directly from the provider's settings.
+
+Returns a `204 No Content` response on success.
+
+<CodeBlock referenceId="pipes_delete_connected_account">
+  <CodeBlockTab title="Request" file="delete-request" />
+</CodeBlock>

package/.docs/organized/docs/reference/pipes/connected-account/get-authorize-url.mdx

@@ -0,0 +1,49 @@
+---
+descriptions:
+  pipes_authorize_url: The OAuth authorization URL to redirect the user to.
+  pipes_authorize:
+    slug: 'The slug identifier of the provider (e.g., `github`, `slack`, `notion`).'
+    user_id: >-
+      A [User](/reference/authkit/user) identifier. This is the user who will
+      authorize the connection.
+    organization_id: >-
+      An [Organization](/reference/organization) identifier. Optional parameter
+      to scope the connection to a specific organization.
+reference:
+  curl:
+    - key: pipes_get_authorize_url
+      id: pipes_get_authorize_url
+      url: /reference/pipes/connected-account/get-authorize-url
+      title: '/data-integrations/:slug/authorize'
+      type: POST
+      parameters:
+        - key: slug
+          type: string
+          description: (pipes_authorize.slug)
+        - key: user_id
+          type: string
+          description: (pipes_authorize.user_id)
+        - key: organization_id
+          type: string
+          description: (pipes_authorize.organization_id)
+          optional: true
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: url
+              type: string
+              description: (pipes_authorize_url)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/pipes/connected-account/get-authorize-url.mdx
+---
+
+## Get authorization URL
+
+Generates an OAuth authorization URL to initiate the connection flow for a user. Redirect the user to the returned URL to begin the OAuth flow with the third-party provider.
+
+<CodeBlock referenceId="pipes_get_authorize_url">
+  <CodeBlockTab title="Request" file="get-authorize-url-request" />
+  <CodeBlockTab title="Response" file="get-authorize-url-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/pipes/connected-account/get.mdx

@@ -0,0 +1,42 @@
+---
+descriptions:
+  pipes_get_connected_account:
+    user_id: 'A [User](/reference/authkit/user) identifier.'
+    slug: 'The slug identifier of the provider (e.g., `github`, `slack`, `notion`).'
+    organization_id: >-
+      An [Organization](/reference/organization) identifier. Optional parameter
+      if the connection is scoped to an organization.
+reference:
+  curl:
+    - key: pipes_get_connected_account
+      id: pipes_get_connected_account
+      url: /reference/pipes/connected-account/get
+      title: '/user_management/users/:user_id/connected_accounts/:slug'
+      type: GET
+      parameters:
+        - key: user_id
+          type: string
+          description: (pipes_get_connected_account.user_id)
+        - key: slug
+          type: string
+          description: (pipes_get_connected_account.slug)
+        - key: organization_id
+          type: string
+          description: (pipes_get_connected_account.organization_id)
+          optional: true
+      returns:
+        - key: connected_account
+          type: connected_account
+          description: 'A [connected account](/reference/pipes/connected-account) object.'
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/pipes/connected-account/get.mdx
+---
+
+## Get a connected account
+
+Retrieves a user's connected account for a specific provider.
+
+<CodeBlock referenceId="pipes_get_connected_account">
+  <CodeBlockTab title="Request" file="get-request" />
+  <CodeBlockTab title="Response" file="get-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/pipes/connected-account/index.mdx

@@ -0,0 +1,69 @@
+---
+descriptions:
+  pipes_connected_account:
+    object: Distinguishes the connected account object.
+    id: The unique identifier of the connected account.
+    user_id: >-
+      The [User](/reference/authkit/user) identifier associated with this
+      connection.
+    organization_id: >-
+      The [Organization](/reference/organization) identifier associated with
+      this connection, or `null` if not scoped to an organization.
+    scopes: The OAuth scopes granted for this connection.
+    state: >
+      The state of the connected account:
+
+      - `connected`: The connection is active and tokens are valid.
+
+      - `needs_reauthorization`: The user needs to reauthorize the connection,
+      typically because required scopes have changed.
+
+      - `disconnected`: The connection has been disconnected.
+    created_at: The timestamp when the connection was created.
+    updated_at: The timestamp when the connection was last updated.
+reference:
+  curl:
+    - url: /reference/pipes/connected-account
+      key: pipes_connected_account
+      id: pipes_connected_account
+      title: connected_account
+      properties:
+        - key: object
+          type: '"connected_account"'
+          description: (pipes_connected_account.object)
+        - key: id
+          type: string
+          description: (pipes_connected_account.id)
+        - key: user_id
+          type: string | null
+          description: (pipes_connected_account.user_id)
+        - key: organization_id
+          type: string | null
+          description: (pipes_connected_account.organization_id)
+        - key: scopes
+          type: 'string[]'
+          description: (pipes_connected_account.scopes)
+        - key: state
+          type: '"connected" | "needs_reauthorization" | "disconnected"'
+          description: (pipes_connected_account.state)
+        - key: created_at
+          type: string
+          description: (pipes_connected_account.created_at)
+        - key: updated_at
+          type: string
+          description: (pipes_connected_account.updated_at)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/pipes/connected-account/index.mdx
+---
+
+# Connected Account
+
+A connected account represents a user's authorized connection to a third-party [provider](/reference/pipes/provider) through Pipes. Connected accounts store the OAuth credentials and scopes granted during the authorization flow.
+
+When listing providers for a user, each provider includes a nested `connected_account` showing the user's connection status.
+
+<CodeBlock
+  title="Connected Account"
+  referenceId="pipes_connected_account"
+  file="connected-account"
+/>

package/.docs/organized/docs/reference/pipes/index.mdx

@@ -0,0 +1,8 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/pipes/index.mdx
+---
+# Pipes
+
+Pipes provides OAuth integrations with third-party providers that allow your users to securely connect their accounts to your application. Pipes handles the complete OAuth lifecycle including token refresh and credential storage.
+
+Read more in the [Pipes guide](/pipes).

package/.docs/organized/docs/reference/pipes/provider/index.mdx

@@ -0,0 +1,70 @@
+---
+descriptions:
+  pipes_provider:
+    object: Distinguishes the provider object.
+    id: The unique identifier of the provider.
+    name: 'The display name of the provider (e.g., "GitHub", "Slack").'
+    description: >-
+      A description of the provider explaining how it will be used, if
+      configured.
+    slug: 'The slug identifier used in API calls (e.g., `github`, `slack`, `notion`).'
+    integration_type: 'The type of integration (e.g., `github`, `slack`).'
+    credentials_type: 'The type of credentials used by the provider (e.g., `oauth2`).'
+    scopes: >-
+      The OAuth scopes configured for this provider, or `null` if none are
+      configured.
+    created_at: The timestamp when the provider was created.
+    updated_at: The timestamp when the provider was last updated.
+    connected_account: >-
+      The user's [connected account](/reference/pipes/connected-account) for
+      this provider, or `null` if the user has not connected.
+reference:
+  curl:
+    - url: /reference/pipes/provider
+      key: pipes_provider
+      id: pipes_provider
+      title: provider
+      properties:
+        - key: object
+          type: '"data_provider"'
+          description: (pipes_provider.object)
+        - key: id
+          type: string
+          description: (pipes_provider.id)
+        - key: name
+          type: string
+          description: (pipes_provider.name)
+        - key: description
+          type: string | null
+          description: (pipes_provider.description)
+        - key: slug
+          type: string
+          description: (pipes_provider.slug)
+        - key: integration_type
+          type: string
+          description: (pipes_provider.integration_type)
+        - key: credentials_type
+          type: string
+          description: (pipes_provider.credentials_type)
+        - key: scopes
+          type: 'string[] | null'
+          description: (pipes_provider.scopes)
+        - key: created_at
+          type: string
+          description: (pipes_provider.created_at)
+        - key: updated_at
+          type: string
+          description: (pipes_provider.updated_at)
+        - key: connected_account
+          type: connected_account | null
+          description: (pipes_provider.connected_account)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/pipes/provider/index.mdx
+---
+
+# Provider
+
+A provider represents a third-party service that users can connect to through Pipes. Providers are configured in the WorkOS Dashboard and define the OAuth scopes and credentials used during the authorization flow.
+
+When listed for a specific user, each provider includes a `connected_account` field showing the user's connection status.
+
+<CodeBlock title="Provider" referenceId="pipes_provider" file="provider" />

package/.docs/organized/docs/reference/pipes/provider/list.mdx

@@ -0,0 +1,47 @@
+---
+descriptions:
+  pipes_list_providers:
+    user_id: >-
+      A [User](/reference/authkit/user) identifier to list providers and
+      connected accounts for.
+    organization_id: >-
+      An [Organization](/reference/organization) identifier. Optional parameter
+      to filter connections for a specific organization.
+reference:
+  curl:
+    - key: pipes_list_providers
+      id: pipes_list_providers
+      url: /reference/pipes/provider/list
+      title: '/user_management/users/:user_id/data_providers'
+      type: GET
+      parameters:
+        - key: user_id
+          type: string
+          description: (pipes_list_providers.user_id)
+        - key: organization_id
+          type: string
+          description: (pipes_list_providers.organization_id)
+          optional: true
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: object
+              type: '"list"'
+            - key: data
+              type: 'provider[]'
+              description: >-
+                A list of [providers](/reference/pipes/provider), each including
+                a `connected_account` field with the user's connection status.
+originalPath: .tmp-workos-clone/packages/docs/content/reference/pipes/provider/list.mdx
+---
+
+## List providers
+
+Retrieves a list of available providers and the user's connection status for each. Returns all providers configured for your environment, along with the user's [connected account](/reference/pipes/connected-account) information where applicable.
+
+<CodeBlock referenceId="pipes_list_providers">
+  <CodeBlockTab title="Request" file="list-request" />
+  <CodeBlockTab title="Response" file="list-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/radar/attempts/index.mdx

@@ -2,6 +2,6 @@
 originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/attempts/index.mdx
 ---
 
-## Attempts
+# Attempts
 
 A Radar attempt represents a sign-in or signup attempt and includes context such as IP address and user agent. The Radar engine assesses attempts for risk and returns a decision that you can use to drive behavior in your application.

package/.docs/organized/docs/reference/radar/lists/index.mdx

@@ -2,6 +2,6 @@
 originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/lists/index.mdx
 ---
 
-## Radar lists
+# Radar lists
 
 Radar supports explicitly blocking and allowing attempts based on attempt attributes. You can manage these lists via the Radar list management APIs

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

@@ -0,0 +1,56 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/rate-limits/index.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 |
+
+## Organizations
+
+| Name                                                  | Path              | Limit                                  |
+| ----------------------------------------------------- | ----------------- | -------------------------------------- |
+| [Delete Organization](/reference/organization/delete) | /organizations/\* | 50 requests per 60 seconds per API key |
+
+## AuthKit
+
+Rate limiting for AuthKit APIs are enforced on a per environment basis.
+
+| Name                                                        | Path                                         | Limit                                                |
+| ----------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------- |
+| Reads                                                       | /user_management/\*                          | 1,000 requests per 10 seconds                        |
+| Writes                                                      | /user_management/\*                          | 500 requests per 10 seconds                          |
+| [Authentication](/reference/authkit/authentication)         | /user_management/authenticate                | 10 requests per 60 seconds per email or challenge ID |
+| [Magic Auth](/reference/authkit/magic-auth)                 | /user_management/magic_auth/send             | 3 requests per 60 seconds per email                  |
+| [Email verification](/reference/authkit/email-verification) | /user_management/:id/email_verification/send | 3 requests per 60 seconds per user                   |
+| [Password reset](/reference/authkit/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         |