@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/session-helpers/authenticate.mdx

@@ -0,0 +1,176 @@
+---
+reference:
+  js:
+    - key: authenticate
+      id: authenticate
+      url: /reference/user-management/session-helpers
+      title: session.authenticate()
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: accessToken
+              type: string
+              description: The access token for the session.
+            - key: sessionId
+              type: string
+              description: The ID of the session.
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organizationId
+              type: string
+              optional: true
+              description: The ID of the organization.
+            - key: role
+              type: string
+              optional: true
+              description: The role of the user.
+            - key: permissions
+              optional: true
+              type: array
+              description: The permissions of the user.
+            - key: entitlements
+              optional: true
+              type: array
+              description: The entitlements of the user.
+            - key: impersonator
+              type: object
+              optional: true
+              properties:
+                - key: email
+                  type: string
+                  description: (authentication.impersonator.email)
+                - key: reason
+                  type: string
+                  optional: true
+                  description: (authentication.impersonator.reason)
+            - key: reason
+              type: >-
+                "invalid_jwt" | "invalid_session_cookie" |
+                "no_session_cookie_provided"
+              optional: true
+              description: >-
+                The reason authentication failed. Only present if `authenticated
+                = false`.
+  ruby:
+    - key: authenticate
+      id: authenticate
+      url: /reference/user-management/session-helpers
+      title: session.authenticate()
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: session_id
+              type: string
+              description: The ID of the session.
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organization_id
+              type: string
+              optional: true
+              description: The ID of the organization.
+            - key: role
+              type: string
+              optional: true
+              description: The role of the user.
+            - key: permissions
+              optional: true
+              type: array
+              description: The permissions of the user.
+            - key: impersonator
+              type: object
+              optional: true
+              properties:
+                - key: email
+                  type: string
+                  description: (authentication.impersonator.email)
+                - key: reason
+                  type: string
+                  optional: true
+                  description: (authentication.impersonator.reason)
+            - key: reason
+              type: >-
+                "invalid_jwt" | "invalid_session_cookie" |
+                "no_session_cookie_provided"
+              optional: true
+              description: >-
+                The reason authentication failed. Only present if `authenticated
+                = false`.
+  python:
+    - key: authenticate
+      id: authenticate
+      url: /reference/user-management/session-helpers
+      title: session.authenticate()
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: session_id
+              type: string
+              description: The ID of the session.
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organization_id
+              type: string
+              optional: true
+              description: The ID of the organization.
+            - key: role
+              type: string
+              optional: true
+              description: The role of the user.
+            - key: permissions
+              optional: true
+              type: array
+              description: The permissions of the user.
+            - key: entitlements
+              optional: true
+              type: array
+              description: The entitlements of the user.
+            - key: impersonator
+              type: object
+              optional: true
+              properties:
+                - key: email
+                  type: string
+                  description: (authentication.impersonator.email)
+                - key: reason
+                  type: string
+                  optional: true
+                  description: (authentication.impersonator.reason)
+            - key: reason
+              type: >-
+                "invalid_jwt" | "invalid_session_cookie" |
+                "no_session_cookie_provided"
+              optional: true
+              description: >-
+                The reason authentication failed. Only present if `authenticated
+                = false`.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/authenticate.mdx
+---
+
+## Authenticate
+
+Unseals the session data and checks if the session is still valid.
+
+<CodeBlock
+  referenceId="authenticate"
+  title="Authenticate"
+  file="session-helpers-authenticate"
+/>

package/.docs/organized/docs/reference/user-management/session-helpers/get-logout-url.mdx

@@ -0,0 +1,42 @@
+---
+reference:
+  js:
+    - key: getLogOutUrl
+      id: get_logout_url_session_helpers
+      url: /reference/user-management/session-helpers
+      title: session.getLogOutUrl()
+      returns:
+        - key: logOutUrl
+          type: string
+          description: The URL to direct a user to for logging out.
+  ruby:
+    - key: get_logout_url
+      id: get_logout_url_session_helpers
+      url: /reference/user-management/session-helpers
+      title: session.get_logout_url()
+      returns:
+        - key: log_out_url
+          type: string
+          description: The URL to direct a user to for logging out.
+  python:
+    - key: get_logout_url
+      id: get_logout_url_session_helpers
+      url: /reference/user-management/session-helpers
+      title: session.get_logout_url()
+      returns:
+        - key: log_out_url
+          type: string
+          description: The URL to direct a user to for logging out.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/get-logout-url.mdx
+---
+
+## Get log out URL
+
+End a user’s session. The user’s browser should be redirected to this URL. Functionally similar to [Get logout URL](/reference/user-management/logout/get-logout-url) but extracts the session ID automatically from the session data.
+
+<CodeBlock
+  referenceId="get_logout_url_session_helpers"
+  title="Get log out URL"
+  file="session-helpers-get-logout-url"
+/>

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

@@ -0,0 +1,14 @@
+---
+description:
+  authentication:
+    session_data: WorkOS session cookie value from the user's browser.
+    cookie_password_unseal: >
+      Password used to unseal the session cookie. Must be the same as the
+      password used to seal the cookie.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/index.mdx
+---
+
+# Session helpers
+
+After authenticating and [storing the encrypted session as a cookie](/user-management/vanilla/nodejs/3-handle-the-user-session/save-the-encrypted-session), retrieving and decrypting the session is made easy via the session helper methods.

package/.docs/organized/docs/reference/user-management/session-helpers/load-sealed-session.mdx

@@ -0,0 +1,105 @@
+---
+reference:
+  js:
+    - key: loadSealedSession
+      id: load_sealed_session
+      url: /reference/user-management/session-helpers
+      title: userManagement.loadSealedSession()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: sessionData
+              type: string
+              description: (authentication.session_data)
+            - key: cookiePassword
+              type: string
+              description: (authentication.cookie_password_unseal)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticate
+              type: function
+              description: Method to authenticate a user with the session cookie
+            - key: refresh
+              type: function
+              description: Method to refresh the user's session
+            - key: getLogOutUrl
+              type: function
+              description: Returns the log out URL
+  ruby:
+    - key: load_sealed_session
+      id: load_sealed_session
+      url: /reference/user-management/session-helpers
+      title: UserManagement.load_sealed_session()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: session_data
+              type: string
+              description: (authentication.session_data)
+            - key: cookie_password
+              type: string
+              description: (authentication.cookie_password_unseal)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticate
+              type: function
+              description: Method to authenticate a user with the session cookie
+            - key: refresh
+              type: function
+              description: Method to refresh the user's session
+            - key: get_logout_url
+              type: function
+              description: Returns the log out URL
+  python:
+    - key: load_sealed_session
+      id: load_sealed_session
+      url: /reference/user-management/session-helpers
+      title: user_management.load_sealed_session()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: sealed_session
+              type: string
+              description: (authentication.session_data)
+            - key: cookie_password
+              type: string
+              description: (authentication.cookie_password_unseal)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticate
+              type: function
+              description: Method to authenticate a user with the session cookie
+            - key: refresh
+              type: function
+              description: Method to refresh the user's session
+            - key: get_logout_url
+              type: function
+              description: Returns the log out URL
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/load-sealed-session.mdx
+---
+
+## Load sealed session
+
+Load the session by providing the sealed session and the cookie password.
+
+<CodeBlock
+  referenceId="load_sealed_session"
+  title="Load sealed session"
+  file="session-helpers-load-sealed-session"
+/>

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

@@ -0,0 +1,213 @@
+---
+reference:
+  js:
+    - key: refresh
+      id: refresh
+      url: /reference/user-management/session-helpers
+      title: session.refresh()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: cookiePassword
+              type: string
+              optional: true
+              description: >-
+                The password with which to encrypt the new session. Only pass
+                this in if you want to set a new password separate from the one
+                provided in `loadSessionData`.
+            - key: organizationId
+              type: string
+              optional: true
+              description: >-
+                The organization ID to use for the new session cookie. Use this
+                if you want to switch organizations.
+      returns:
+        - key: anonymous
+          type: RefreshSessionResponse
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: session
+              type: object
+              description: The user session.
+            - key: sealedSession
+              type: string
+              description: >-
+                Sealed version of the user session. Use this in the session
+                cookie.
+            - key: sessionId
+              type: string
+              description: The ID of the session.
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organizationId
+              type: string
+              optional: true
+              description: The ID of the organization.
+            - key: role
+              type: string
+              optional: true
+              description: The role of the user.
+            - key: permissions
+              optional: true
+              type: array
+              description: The permissions of the user.
+            - key: entitlements
+              optional: true
+              type: array
+              description: The entitlements of the user.
+            - key: impersonator
+              type: object
+              optional: true
+              properties:
+                - key: email
+                  type: string
+                  description: (authentication.impersonator.email)
+                - key: reason
+                  type: string
+                  optional: true
+                  description: (authentication.impersonator.reason)
+            - key: reason
+              type: string
+              optional: true
+              description: >-
+                The reason the session failed to refresh. Only present if
+                `authenticated = false`.
+  ruby:
+    - key: refresh
+      id: refresh
+      url: /reference/user-management/session-helpers
+      title: session.refresh()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: cookie_password
+              type: string
+              optional: true
+              description: >-
+                The password with which to encrypt the new session. Only pass
+                this in if you want to set a new password separate from the one
+                provided in `load_session_data`.
+            - key: organization_id
+              type: string
+              optional: true
+              description: >-
+                The organization ID to use for the new session cookie. Use this
+                if you want to switch organizations.
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: session
+              type: object
+              description: The user session.
+            - key: sealed_session
+              type: string
+              description: >-
+                Sealed version of the user session. Use this in the session
+                cookie.
+            - key: reason
+              type: string
+              optional: true
+              description: >-
+                The reason the session failed to refresh. Only present if
+                `authenticated = false`.
+  python:
+    - key: refresh
+      id: refresh
+      url: /reference/user-management/session-helpers
+      title: session.refresh()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: cookie_password
+              type: string
+              optional: true
+              description: >-
+                The password with which to encrypt the new session. Only pass
+                this in if you want to set a new password separate from the one
+                provided in `load_session_data`.
+            - key: organization_id
+              type: string
+              optional: true
+              description: >-
+                The organization ID to use for the new session cookie. Use this
+                if you want to switch organizations.
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: sealed_session
+              type: string
+              description: >-
+                Sealed version of the user session. Use this in the session
+                cookie.
+            - key: session_id
+              type: string
+              description: The ID of the session.
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organization_id
+              type: string
+              optional: true
+              description: The ID of the organization.
+            - key: role
+              type: string
+              optional: true
+              description: The role of the user.
+            - key: permissions
+              optional: true
+              type: array
+              description: The permissions of the user.
+            - key: entitlements
+              optional: true
+              type: array
+              description: The entitlements of the user.
+            - key: impersonator
+              type: object
+              optional: true
+              properties:
+                - key: email
+                  type: string
+                  description: (authentication.impersonator.email)
+                - key: reason
+                  type: string
+                  optional: true
+                  description: (authentication.impersonator.reason)
+            - key: reason
+              type: string
+              optional: true
+              description: >-
+                The reason the session failed to refresh. Only present if
+                `authenticated = false`.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/refresh.mdx
+---
+
+## Refresh
+
+Refreshes the user's session with the refresh token. Passing in a new organization ID will switch the user to that organization.
+
+<CodeBlock
+  referenceId="refresh"
+  title="Refresh"
+  file="session-helpers-refresh"
+/>

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

@@ -0,0 +1,90 @@
+---
+descriptions:
+  access_token:
+    permissions: >-
+      The slugs of the permissions assigned on the [organization
+      membership](/reference/user-management/organization-membership) via the
+      role.
+    entitlements: >
+      The lookup keys of the Stripe entitlements available to the user’s
+      [Organization](/reference/organization).
+    role: >-
+      Corresponds to the role on the [organization
+      membership](/reference/user-management/organization-membership)
+    session_id: >-
+      The session ID. You would use this with the [logout
+      endpoint](/reference/user-management/logout).
+reference:
+  json:
+    - key: access_token
+      id: access_token
+      url: /reference/user-management/session-tokens/access-token
+      title: Access Token JWT
+      properties:
+        - key: iss
+          type: string
+          description: >
+            The issuer of the JWT, will be your custom WorkOS auth domain if
+            set.
+        - key: sub
+          type: string
+          description: (user.id)
+        - key: act
+          type: object
+          description: >
+            An [RFC
+            8693](https://www.rfc-editor.org/rfc/rfc8693#name-act-actor-claim)
+            compatible claim
+
+            present when the session was started using
+            [impersonation](/user-management/impersonation).
+
+
+            The nested `sub` claim contains the email adddress of the WorkOS
+            Dashboard user impersonating
+
+            the user.
+          optional: true
+        - key: org_id
+          type: string
+          description: (authentication.organization_id)
+        - key: role
+          type: string
+          description: (access_token.role)
+        - key: permissions
+          type: 'string[]'
+          description: (access_token.permissions)
+          optional: true
+        - key: entitlements
+          type: 'string[]'
+          description: (access_token.entitlements)
+          optional: true
+        - key: sid
+          type: string
+          description: (access_token.session_id)
+        - key: jti
+          type: string
+          description: A unique identifier for this access token.
+        - key: exp
+          type: DateTime
+          description: >-
+            The token should not be trusted after this time. The timestamp is
+            the number of seconds since epoch.
+        - key: iat
+          type: DateTime
+          description: >-
+            The token was issued at this time. The timestamp is the number of
+            seconds since epoch.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/access-token.mdx
+---
+
+## Access token
+
+The access token that is returned in successful authentication responses is a JWT that can be used to verify that a user has an active session. The JWT is signed by a JWKS which can be retrieved from the [WorkOS API](/reference/user-management/session-tokens/jwks).
+
+<CodeBlock
+  title="Decoded access token"
+  referenceId="access_token"
+  file="access-token"
+/>

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

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