@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/vault/object/versions.mdx

@@ -0,0 +1,83 @@
+---
+descriptions:
+  list_object_versions:
+    data: >-
+      Array of [object versions](/reference/vault/object/version) ordered by
+      creation time.
+reference:
+  curl:
+    - key: list_object_versions
+      id: list_object_versions
+      url: /reference/vault/object/versions
+      title: '/vault/v1/kv/:id/versions'
+      type: GET
+      parameters:
+        - (object.id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_object_versions.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (after)
+                - (before)
+  js:
+    - key: listObjectVersions
+      id: list_object_versions
+      url: /reference/vault/object/versions
+      title: vault.listObjectVersions()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'ObjectVersion[]'
+              description: (list_object_versions.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (after)
+                - (before)
+  go:
+    - key: ListObjectVersions
+      id: list_object_versions
+      url: /reference/vault/object/versions
+      title: vault.ListObjectVersions()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.ReadObjectOpts
+          expanded: true
+          properties:
+            - (Object.Id)
+      returns:
+        - key: listResponse
+          type: vault.ListObjectVersionsResponse
+          unwrap: true
+          properties:
+            - key: data
+              type: 'ObjectVersion[]'
+              description: (list_object_versions.data)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/versions.mdx
+---
+
+## List object versions
+
+Get list of versions for an object stored in Vault.
+
+<CodeBlock referenceId="list_object_versions">
+  <CodeBlockTab title="Request" file="list-object-versions-request" />
+  <CodeBlockTab title="Response" file="list-object-versions-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/widgets/get-token.mdx

@@ -0,0 +1,185 @@
+---
+descriptions:
+  widget_token: An ephemeral token to access WorkOS widgets.
+  get_token:
+    organization_id: 'An [Organization](/reference/organization) identifier.'
+    user_id: 'A [User](/reference/user-management/user) identifier.'
+    scopes: >-
+      The scopes to grant the widget token. Currently supported scope is
+      `widgets:users-table:manage`.
+reference:
+  curl:
+    - key: get_token
+      id: get_token
+      url: /reference/widgets/get-token
+      title: /widgets/token
+      type: POST
+      parameters:
+        - key: organization_id
+          type: string
+          description: (get_token.organization_id)
+        - key: user_id
+          type: string
+          description: (get_token.user_id)
+        - key: scopes
+          type: array
+          description: (get_token.scopes)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: token
+              type: string
+              description: (widget_token)
+  ruby:
+    - key: get_token
+      id: get_token
+      url: /reference/widgets/get-token
+      title: Widgets.get_token()
+      parameters:
+        - key: organization_id
+          type: String
+          description: (get_token.organization_id)
+        - key: user_id
+          type: String
+          description: (get_token.user_id)
+        - key: scopes
+          type: 'Array[WidgetScope]'
+          description: (get_token.scopes)
+      returns:
+        - key: token
+          type: String
+          description: (widget_token)
+  js:
+    - key: getToken
+      id: get_token
+      url: /reference/widgets/get-token
+      title: widgets.getToken()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (get_token.organization_id)
+            - key: userId
+              type: string
+              description: (get_token.user_id)
+            - key: scopes
+              type: 'string[]'
+              description: (get_token.scopes)
+      returns:
+        - key: token
+          type: String
+          description: (widget_token)
+  python:
+    - key: get_token
+      id: get_token
+      url: /reference/widgets/get-token
+      title: widgets.get_token()
+      parameters:
+        - key: organization_id
+          type: str
+          description: (get_token.organization_id)
+        - key: user_id
+          type: str
+          description: (get_token.user_id)
+        - key: scopes
+          type: 'Sequence[WidgetScope]'
+          description: (get_token.scopes)
+      returns:
+        - key: anonymous
+          type: WidgetTokenResponse
+          unwrap: true
+          properties:
+            - key: token
+              type: str
+              description: (widget_token)
+  go:
+    - key: GetToken
+      id: get_token
+      url: /reference/widgets/get-token
+      title: widgets.GetToken()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: widgets.GetTokenOpts
+          expanded: true
+          properties:
+            - key: OrganizationId
+              type: string
+              description: (get_token.organization_id)
+            - key: UserId
+              type: string
+              description: (get_token.user_id)
+            - key: Scopes
+              type: '[]WidgetScope'
+              description: The scopes to grant the widget token.
+      returns:
+        - key: token
+          type: string
+          description: (widget_token)
+        - (err)
+  php:
+    - key: getToken
+      id: get_token
+      url: /reference/widgets/get-token
+      title: $widgets->getToken()
+      parameters:
+        - key: organization_id
+          type: string
+          description: (get_token.organization_id)
+        - key: user_id
+          type: string
+          description: (get_token.user_id)
+        - key: scopes
+          type: array
+          description: (get_token.scopes)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - key: token
+              type: string
+              description: (widget_token)
+  java:
+    - key: get_token
+      id: get_token
+      url: /reference/widgets/get-token
+      title: workos.widgets.getToken()
+      parameters:
+        - key: options
+          type: GetTokenOptions
+          expanded: true
+          properties:
+            - key: organizationId
+              type: String
+              description: (get_token.organization_id)
+            - key: userId
+              type: String
+              description: (get_token.user_id)
+            - key: scopes
+              type: List<WidgetScope>
+              description: The scopes to grant the widget token.
+      returns:
+        - key: response
+          type: WidgetTokenResponse
+          expanded: true
+          properties:
+            - key: token
+              type: String
+              description: (widget_token)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/widgets/get-token.mdx
+---
+
+## Generate a Widget token
+
+Generate a widget token scoped to an organization and user with the specified scopes.
+
+<CodeBlock referenceId="get_token">
+  <CodeBlockTab title="Request" file="get-token-request" />
+  <CodeBlockTab title="Response" file="get-token-response" />
+</CodeBlock>

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

@@ -0,0 +1,6 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/widgets/index.mdx
+---
+# Widgets
+
+Widgets are React components that provide complete functionality for common enterprise app workflows.

package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx

@@ -0,0 +1,75 @@
+---
+descriptions:
+  workos_connect_authorize:
+    client_id: |
+      The client ID of the WorkOS Connect Application.
+    nonce: >
+      A random string generated by the client that is used to mitigate replay
+      attacks.
+    redirect_uri: |
+      The URL to redirect the user to after they have logged in.
+    response_type: >
+      The type of authentication flow. Currently, the only supported value is
+      `"code"`.
+    scope: |
+      A space-separated list of scopes being requested.
+
+      Acceptable values:
+      - `openid`: Required to enable other scopes like `profile` and `email`.
+      - `profile`: Adds profile information (name fields) to the ID token.
+        - `name`
+        - `given_name`
+        - `family_name`
+      - `email`: Adds email information to the ID token.
+        - `email`
+        - `email_verified`
+      - `offline_access`: Adds a refresh token to the response.
+    state: >
+      An opaque string used by the client to maintain state between the request
+      and callback.
+  workos_connect_authorize_response:
+    url: |
+      The OAuth 2.0 authorization URL to redirect the user to.
+reference:
+  curl:
+    - url: /reference/workos-connect/authorize
+      key: workos_connect_authorize
+      id: workos_connect_authorize
+      title: /oauth2/authorize
+      type: GET
+      parameters:
+        - key: client_id
+          type: string
+          description: (workos_connect_authorize.client_id)
+        - key: nonce
+          type: string
+          description: (workos_connect_authorize.nonce)
+        - key: redirect_uri
+          type: string
+          description: (workos_connect_authorize.redirect_uri)
+        - key: response_type
+          type: '"code"'
+          description: (workos_connect_authorize.response_type)
+        - key: scope
+          type: string
+          description: (workos_connect_authorize.scope)
+        - key: state
+          type: string
+          description: (workos_connect_authorize.state)
+          optional: true
+      returns:
+        - key: url
+          type: string
+          description: (workos_connect_authorize_response.url)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/authorize/index.mdx
+---
+
+## Authorize
+
+When authenticating a user for a WorkOS Connect application, this is the endpoint they should be redirected to. If they’re not already logged in, the user will be redirected to the AuthKit login page. For a third-party application, the user will have to authorize the application’s access on their first access.
+
+<CodeBlock referenceId="workos_connect_authorize">
+  <CodeBlockTab title="Request" file="authorize-request" />
+  <CodeBlockTab title="Response" file="authorize-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/index.mdx

@@ -0,0 +1,33 @@
+---
+descriptions:
+  workos_connect_id_token:
+    iss: |
+      The issuer of the JWT, your AuthKit domain (`https://authkit_domain`).
+    aud: |
+      The client ID of the WorkOS Connect Application.
+    sub: (user.id)
+    name: |
+      The full name of the user. Available with the `profile` claim.
+    given_name: |
+      The first name of the user. Available with the `profile` claim.
+    family_name: |
+      The surname of the user. Available with the `profile` claim.
+    email: |
+      The user’s email address. Available with the `email` claim.
+    email_verified: >
+      Whether the user’s email address is verified. Available with the `email`
+      claim.
+    exp: >
+      The token should not be trusted after this time. The timestamp is the
+      number of seconds since epoch.
+    iat: >
+      The token was issued at this time. The timestamp is the number of seconds
+      since epoch.
+originalPath: .tmp-workos-clone/packages/docs/content/reference/workos-connect/index.mdx
+---
+
+# WorkOS Connect
+
+WorkOS Connect is a unified interface that simplifies authentication and authorization across customers, partners, and external SaaS tools.
+
+Read more about [how Connect integrates with AuthKit here](/user-management/connect).

package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx

@@ -0,0 +1,122 @@
+---
+descriptions:
+  workos_connect_introspection:
+    token: |
+      The token (an access token or refresh token) to return information for.
+    token_type_hint: >
+      An optional hint for the type of token provided. This can be either
+      `"access_token"` or `"refresh_token"`.
+  workos_connect_introspection_response:
+    active: |
+      Whether the token is valid (e.g. exists and is not expired).
+    iss: |
+      The issuer of the token. Your AuthKit domain.
+    sub: >
+      The user ID for the OAuth app access token or refresh token. For an M2M
+      app, this is the Applcation’s client ID.
+    sid: >
+      Identifies the consent previously given by the user. Only present for
+      OAuth Application access tokens.
+    org_id: >
+      For an M2M token, this is the identifier of the associated
+      [Organization](/reference/organization).
+    jti: >
+      A unique identifer for the token. Only present for OAuth Application
+      access tokens.
+    token_type: |
+      Either `"access_token"` or `"refresh_token"`.
+    exp: >
+      The token should not be trusted after this time. The timestamp is the
+      number of seconds since epoch. Only returned for access tokens.
+    iat: >
+      The token was issued at this time. The timestamp is the number of seconds
+      since epoch.
+reference:
+  curl:
+    - url: /reference/workos-connect/introspection
+      key: workos_connect_introspection
+      id: workos_connect_introspection
+      title: /oauth2/token
+      type: POST
+      parameters:
+        - key: client_id
+          type: string
+          description: (workos_connect_token_request.client_id)
+        - key: client_secret
+          type: string
+          description: (workos_connect_token_request.client_secret)
+        - key: token
+          type: string
+          description: (workos_connect_introspection.token)
+        - key: token_type_hint
+          type: '"access_token" | "refresh_token"'
+          optional: true
+          description: (workos_connect_introspection.token_type_hint)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: active
+              type: boolean
+              description: (workos_connect_introspection_response.active)
+            - key: token_type
+              type: '"access_token" | "refresh_token"'
+              description: (workos_connect_introspection_response.token_type)
+            - key: client_id
+              type: string
+              description: (workos_connect_token_request.client_id)
+            - key: iss
+              type: string
+              description: (workos_connect_introspection_response.iss)
+            - key: sub
+              type: string
+              description: (workos_connect_introspection_response.sub)
+            - key: iat
+              type: integer
+              description: (workos_connect_introspection_response.iat)
+            - key: sid
+              type: string
+              optional: true
+              description: (workos_connect_introspection_response.sid)
+            - key: jti
+              type: string
+              optional: true
+              description: (workos_connect_introspection_response.jti)
+            - key: org_id
+              type: string
+              optional: true
+              description: (workos_connect_introspection_response.org_id)
+            - key: exp
+              type: integer
+              optional: true
+              description: (workos_connect_introspection_response.exp)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/introspection/index.mdx
+---
+
+## Token introspection
+
+Indicates whether the given token (access token or refresh token) is valid and active. Additionally, it provides details about the token.
+
+This endpoint is authenticated by provided the WorkOS Application’s client ID and client secret in the body of the request.
+
+<CodeBlock referenceId="workos_connect_introspection">
+  <CodeBlockTab title="Request" file="workos-connect-introspection-request" />
+  <CodeBlockTab
+    title="Access token"
+    file="workos-connect-introspection-response-access-token"
+  />
+  <CodeBlockTab
+    title="Access token (M2M)"
+    file="workos-connect-introspection-response-access-token-m2m"
+  />
+  <CodeBlockTab
+    title="Refresh token"
+    file="workos-connect-introspection-response-refresh-token"
+  />
+  <CodeBlockTab
+    title="Invalid"
+    file="workos-connect-introspection-response-invalid-token"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx

@@ -0,0 +1,25 @@
+---
+descriptions:
+  workos_connect_well_known_metadata:
+    issuer: |
+      The URL of the issuer, which is your AuthKit domain.
+    authorization_endpoint: |
+      The URL of the authorization endpoint that initiates the OAuth flow.
+    grant_types_supported: |
+      A list of the available grant types available at the token endpoint.
+    introspection_endpoint: >
+      The URL of the introspection endpoint that can be used to validate access
+      and refresh tokens.
+    response_types_supported: >
+      A list of the response types supported by the authorization endpoint.
+      Currently this is always `["code"]`.
+    token_endpoint: >
+      The URL of the token endpoint that can be used to exchange authorization
+      codes for tokens.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/metadata/index.mdx
+---
+
+## Metadata
+
+Connect exposes several metadata endpoints in order to be compatible with a wide array of clients that support discovery and automatic configuration.

package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx

@@ -0,0 +1,99 @@
+---
+reference:
+  curl:
+    - url: /reference/workos-connect/oauth-authorization-server
+      key: connect_oauth_authorization_server_metadata
+      id: connect_oauth_authorization_server_metadata
+      title: /.well-known/oauth-authorization-server
+      type: GET
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authorization_endpoint
+              type: string
+              description: (workos_connect_well_known_metadata.authorization_endpoint)
+            - key: code_challenge_methods_supported
+              type: array
+              description: >
+                Which PKCE code challenge methods the authorization endpoint
+                will accept. Currently
+
+                only `S256` is supported.
+            - key: grant_types_supported
+              type: array
+              description: (workos_connect_well_known_metadata.grant_types_supported)
+            - key: introspection_endpoint
+              type: string
+              description: (workos_connect_well_known_metadata.introspection_endpoint)
+            - key: issuer
+              type: string
+              description: (workos_connect_well_known_metadata.issuer)
+            - key: registration_endpoint
+              type: string
+              description: >
+                The URL of the dynamic client registration endpoint, as per
+
+                [RFC 7591](https://datatracker.ietf.org/doc/html/rfc7591). Only
+                returned if enabled
+
+                for the environment.
+            - key: scopes_supported
+              type: array
+              description: >
+                Which builtin scopes are supported in the `scope` parameter of
+                the authorization
+
+                endpoint.
+            - key: response_modes_supported
+              type: array
+              description: >
+                Which methods are supported in delivering authentication
+                responses. Only `query` is
+
+                supported, meaning authorization codes or errors will be encoded
+                into the query string.
+            - key: response_types_supported
+              type: array
+              description: (workos_connect_well_known_metadata.response_types_supported)
+            - key: token_endpoint
+              type: string
+              description: (workos_connect_well_known_metadata.token_endpoint)
+            - key: token_endpoint_auth_methods_supported
+              type: array
+              description: >
+                How clients can authenticate themselves with the token endpoint.
+                Currently
+
+                supported values are the following:
+
+
+                * **none** – No auth is allowed when using PKCE.
+
+                * **client_secret_post** – Credentials can be passed in the
+                request body
+                  as `client_id` and `client_secret`.
+                * **client_secret_basic** – Credentials can be passed in the
+                Authorization
+                  header following [RFC 2617](https://datatracker.ietf.org/doc/html/rfc2617).
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/metadata/oauth-authorization-server/index.mdx
+---
+
+### OAuth Authorization Server
+
+This endpoint provides [RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749)-compatible OAuth Authorization Server metadata.
+
+Model Context Protocol (MCP) clients that support the latest version of the specification use this endpoint. [Read more here](/user-management/mcp) about how to use AuthKit as an authorization server for an MCP server.
+
+<CodeBlock referenceId="connect_oauth_authorization_server_metadata">
+  <CodeBlockTab
+    title="Request"
+    file="connect-oauth-authorization-server-metadata-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="connect-oauth-authorization-server-metadata-response"
+  />
+</CodeBlock>