@workos/mcp-docs-server 0.1.0

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

@@ -0,0 +1,381 @@
+---
+descriptions:
+  authentication:
+    refresh_token: The `refresh_token` received from a successful authentication response.
+    refresh_organization_id: >
+      The organization to authorize in the new access token. If the current
+
+      session is not authorized for the organization, an appropriate
+
+      [authentication error](/reference/user-management/authentication-errors)
+      will be returned.
+
+
+      If no organization ID is provided, then the access token will default to
+      the
+
+      original organization selected.
+reference:
+  curl:
+    - key: authenticate-refresh-token
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: /user_management/authenticate
+      type: POST
+      parameters:
+        - key: client_id
+          type: string
+          description: (client_id)
+        - key: client_secret
+          type: string
+          description: (client_secret)
+        - key: grant_type
+          type: '"refresh_token"'
+          description: (authentication.grant_type)
+        - key: refresh_token
+          type: string
+          description: (authentication.refresh_token)
+        - key: organization_id
+          type: string
+          optional: true
+          description: (authentication.refresh_organization_id)
+        - key: ip_address
+          type: string
+          optional: true
+          description: (authentication.ip_address)
+        - key: user_agent
+          type: string
+          optional: true
+          description: (authentication.user_agent)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: user
+              type: user
+              description: (user.self)
+            - key: organization_id
+              type: string
+              optional: true
+              description: (authentication.organization_id)
+            - key: access_token
+              type: String
+              optional: false
+              description: |
+                A JWT containing information about the session.
+            - key: refresh_token
+              type: String
+              optional: false
+              description: >
+                [Exchange this
+                token](/reference/user-management/authentication/refresh-token)
+                for a new access token.
+            - key: authentication_method
+              type: >-
+                "SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
+                "GoogleOAuth" | "MicrosoftOAuth" | "MagicAuth" | "Impersonation"
+              optional: false
+              description: (authentication.authentication_method)
+            - 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)
+  js:
+    - key: authenticateWithRefreshToken
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: userManagement.authenticateWithRefreshToken()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: clientId
+              type: string
+              description: (client_id)
+            - key: refresh_token
+              type: string
+              description: (authentication.refresh_token)
+            - key: organizationId
+              type: string
+              optional: true
+              description: (authentication.refresh_organization_id)
+            - key: ipAddress
+              type: string
+              optional: true
+              description: (authentication.ip_address)
+            - key: userAgent
+              type: string
+              optional: true
+              description: (authentication.user_agent)
+            - key: session
+              type: object
+              optional: true
+              unwrap: true
+              properties:
+                - key: sealSession
+                  type: boolean
+                  description: (authentication.seal_session)
+                - key: cookiePassword
+                  type: string
+                  optional: true
+                  description: (authentication.cookie_password_seal)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: user
+              type: User
+              description: (user.self)
+            - key: organizationId
+              type: string
+              optional: true
+              description: (authentication.organization_id)
+            - key: accessToken
+              type: string
+              optional: false
+              description: |
+                A JWT containing information about the session.
+            - key: refreshToken
+              type: string
+              optional: false
+              description: >
+                [Exchange this
+                token](/reference/user-management/authentication/refresh-token)
+                for new access tokens.
+            - key: authenticationMethod
+              type: >-
+                "SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
+                "GoogleOAuth" | "MicrosoftOAuth" | "MagicAuth" | "Impersonation"
+              optional: false
+              description: (authentication.authentication_method)
+            - 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: sealedSession
+              type: string
+              optional: true
+              description: (authentication.sealed_session)
+  python:
+    - key: authenticate_with_refresh_token
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: user_management.authenticate_with_refresh_token()
+      parameters:
+        - key: refresh_token
+          type: str
+          description: (authentication.refresh_token)
+        - key: organization_id
+          type: string
+          optional: true
+          description: (authentication.refresh_organization_id)
+        - key: ip_address
+          type: str
+          optional: true
+          description: (authentication.ip_address)
+        - key: user_agent
+          type: str
+          optional: true
+          description: (authentication.user_agent)
+      returns:
+        - key: anonymous
+          type: RefreshTokenAuthenticationResponse
+          unwrap: true
+          properties:
+            - key: access_token
+              type: str
+              description: (authentication.access_token)
+            - key: refresh_token
+              type: str
+              description: (authentication.refresh_token)
+  go:
+    - key: AuthenticateWithRefreshToken
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: usermanagement.AuthenticateWithRefreshToken()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.AuthenticateWithRefreshTokenOpts
+          unwrap: true
+          properties:
+            - key: ClientID
+              type: string
+              description: (client_id)
+            - key: RefreshToken
+              type: string
+              description: (authentication.refresh_token)
+            - key: OrganizationID
+              type: string
+              optional: true
+              description: (authentication.refresh_organization_id)
+            - key: IPAddress
+              type: string
+              optional: true
+              description: (authentication.ip_address)
+            - key: UserAgent
+              type: string
+              optional: true
+              description: (authentication.user_agent)
+      returns:
+        - key: response
+          type: object
+          unwrap: true
+          properties:
+            - key: AccessToken
+              type: string
+              description: (authentication.access_token)
+            - key: RefreshToken
+              type: string
+              description: (authentication.refresh_token)
+        - (err)
+  ruby:
+    - key: authenticate_with_refresh_token
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: UserManagement.authenticate_with_refreshToken()
+      parameters:
+        - key: client_id
+          type: String
+          description: (client_id)
+        - key: refresh_token
+          type: String
+          description: (authentication.refresh_token)
+        - key: organization_id
+          type: string
+          optional: true
+          description: (authentication.refresh_organization_id)
+        - key: ip_address
+          type: String
+          optional: true
+          description: (authentication.ip_address)
+        - key: user_agent
+          type: String
+          optional: true
+          description: (authentication.user_agent)
+      returns:
+        - key: response
+          type: object
+          unwrap: true
+          properties:
+            - key: access_token
+              type: String
+              description: (authentication.access_token)
+            - key: refresh_token
+              type: String
+              optional: true
+              description: (authentication.refresh_token)
+  java:
+    - key: authenticateWithRefreshToken
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: userManagement.authenticateWithRefreshToken()
+      parameters:
+        - key: client_id
+          type: String
+          description: (client_id)
+        - key: refreshToken
+          type: String
+          description: (authentication.refresh_token)
+        - key: organizationId
+          type: string
+          optional: true
+          description: (authentication.refresh_organization_id)
+        - key: options
+          type: AuthenticationAdditionalOptionsBuilder
+          optional: true
+          unwrap: true
+          properties:
+            - key: invitationToken
+              type: String
+              optional: true
+              description: (authentication.invitation_token)
+            - key: ipAddress
+              type: String
+              optional: true
+              description: (authentication.ip_address)
+            - key: userAgent
+              type: String
+              optional: true
+              description: (authentication.user_agent)
+      returns:
+        - key: response
+          type: RefreshAuthentication
+          unwrap: true
+          properties:
+            - key: accessToken
+              type: string
+              description: (authentication.access_token)
+            - key: refreshToken
+              type: string
+              description: (authentication.refresh_token)
+  php:
+    - key: authenticateWithRefreshToken
+      id: authenticate_with_refresh_token
+      url: /reference/user-management/authentication/refresh-token
+      title: $userManagement->authenticateWithRefreshToken()
+      parameters:
+        - key: clientID
+          type: string
+          description: (client_id)
+        - key: refreshToken
+          type: string
+          description: (authentication.refresh_token)
+        - key: organizationID
+          type: string
+          optional: true
+          description: (authentication.refresh_organization_id)
+        - key: ipAddress
+          type: string
+          optional: true
+          description: (authentication.ip_address)
+        - key: userAgent
+          type: string
+          optional: true
+          description: (authentication.user_agent)
+      returns:
+        - key: response
+          type: RefreshAuthentication
+          unwrap: true
+          properties:
+            - key: accessToken
+              type: string
+              description: (authentication.access_token)
+            - key: refreshToken
+              type: string
+              description: (authentication.refresh_token)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/authentication/refresh-token.mdx
+---
+
+## Authenticate with refresh token
+
+Use this endpoint to exchange a refresh token for a new access token. Refresh tokens are single use, so a new refresh token is returned.
+
+<CodeBlock referenceId="authenticate_with_refresh_token">
+  <CodeBlockTab
+    title="Request"
+    file="authenticate-with-refresh-token-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="authenticate-with-refresh-token-response"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/authentication/session-cookie.mdx

@@ -0,0 +1,79 @@
+---
+descriptions:
+  authentication:
+    authenticated: Whether or not the user was successfully authenticated.
+    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. Can optionally be specified as the
+      `WORKOS_COOKIE_PASSWORD` environment variable.
+reference:
+  js:
+    - key: authenticateWithSessionCookie
+      id: authenticate_with_session_cookie
+      url: /reference/user-management/authentication/session-cookie
+      title: userManagement.authenticateWithSessionCookie()
+      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: authenticated
+              type: boolean
+              description: (authentication.authenticated)
+            - key: sessionId
+              type: string
+              description: (access_token.session_id)
+            - key: organizationId
+              type: string
+              optional: true
+              description: (authentication.organization_id)
+            - key: role
+              type: string
+              optional: true
+              description: (access_token.role)
+            - key: permissions
+              type: string
+              optional: true
+              description: (access_token.permissions)
+            - 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/authentication/session-cookie.mdx
+---
+
+## Authenticate with session cookie
+
+Authenticates a user using an AuthKit session cookie. This method does not make a network call, but simply unseals an existing session cookie and decodes the JWT claims from the [access token](/reference/user-management/session-tokens/access-token).
+
+<CodeBlock referenceId="authenticate_with_session_cookie">
+  <CodeBlockTab
+    title="Request"
+    file="authenticate-with-session-cookie-request"
+  />
+  <CodeBlockTab
+    title="Success response"
+    file="authenticate-with-session-cookie-success-response"
+  />
+  <CodeBlockTab
+    title="Failure response"
+    file="authenticate-with-session-cookie-failure-response"
+  />
+</CodeBlock>