@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/magic-link/passwordless-session/create.mdx

@@ -0,0 +1,268 @@
+---
+descriptions:
+  create_passwordless_session:
+    email: The email of the user to authenticate.
+    type: >-
+      The type of Passwordless Session to create. Currently, the only supported
+      value is `MagicLink`.
+    redirect_uri: >-
+      Optional parameter that a developer can choose to include in their
+      authorization URL. If included, it will override the default Redirect URI
+      set in the dashboard. This is the location your user will be redirected to
+      once the session has been completed successfully.
+    expires_in: >
+      The number of seconds the Passwordless Session should live before
+      expiring.
+
+
+      This value must be between `900` (15 minutes) and `86400` (24 hours),
+      inclusive.
+    state: >
+      Optional parameter that a developer can choose to include in their
+      authorization URL. If included, then the redirect URI received from WorkOS
+      will contain the exact `state` that was passed in the authorization URL.
+
+
+      The `state` parameter can be used to encode arbitrary information to help
+      restore application state between redirects.
+reference:
+  curl:
+    - key: create_passwordless_session
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: /passwordless/sessions
+      type: POST
+      parameters:
+        - key: email
+          type: string
+          description: (create_passwordless_session.email)
+        - key: type
+          type: '"MagicLink"'
+          description: (create_passwordless_session.type)
+        - key: redirect_uri
+          type: string
+          optional: true
+          description: (create_passwordless_session.redirect_uri)
+        - key: expires_in
+          type: number
+          optional: true
+          description: (create_passwordless_session.expires_in)
+        - key: state
+          type: string
+          optional: true
+          description: (create_passwordless_session.state)
+      returns:
+        - (passwordless_session)
+  dotnet:
+    - key: CreateSession
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: passwordlessService.CreateSession()
+      parameters:
+        - key: options
+          type: CreatePasswordlessSessionOptions
+          expanded: true
+          properties:
+            - key: Email
+              type: string
+              description: (create_passwordless_session.email)
+            - key: Type
+              type: PasswordlessSessionType
+              description: (create_passwordless_session.type)
+            - key: RedirectURI
+              type: string
+              optional: true
+              description: (create_passwordless_session.redirect_uri)
+            - key: ExpiresIn
+              type: int
+              optional: true
+              description: (create_passwordless_session.expires_in)
+            - key: State
+              type: string
+              optional: true
+              description: (create_passwordless_session.state)
+        - (cancellationToken)
+      returns:
+        - key: Task<PasswordlessSession>
+          description: (passwordless_session.self)
+  python:
+    - key: create_session
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: passwordless.create_session()
+      parameters:
+        - key: email
+          type: str
+          description: (create_passwordless_session.email)
+        - key: type
+          type: '"MagicLink"'
+          description: (create_passwordless_session.type)
+        - key: redirect_uri
+          type: str
+          optional: true
+          description: (create_passwordless_session.redirect_uri)
+        - key: state
+          type: str
+          optional: true
+          description: (create_passwordless_session.state)
+      returns:
+        - (PasswordlessSession)
+  js:
+    - key: createSession
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: passwordless.createSession()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: email
+              type: string
+              description: (create_passwordless_session.email)
+            - key: type
+              type: '"MagicLink"'
+              description: (create_passwordless_session.type)
+            - key: redirectURI
+              type: string
+              optional: true
+              description: (create_passwordless_session.redirect_uri)
+            - key: expiresIn
+              type: number
+              optional: true
+              description: (create_passwordless_session.expires_in)
+            - key: state
+              type: string
+              optional: true
+              description: (create_passwordless_session.state)
+      returns:
+        - (PasswordlessSession)
+  ruby:
+    - key: create_session
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: Passwordless.create_session()
+      parameters:
+        - key: email
+          type: String
+          description: (create_passwordless_session.email)
+        - key: type
+          type: '"MagicLink"'
+          description: (create_passwordless_session.type)
+        - key: redirect_uri
+          type: String
+          optional: true
+          description: (create_passwordless_session.redirect_uri)
+        - key: expires_in
+          type: Integer
+          optional: true
+          description: (create_passwordless_session.expires_in)
+        - key: state
+          type: String
+          optional: true
+          description: (create_passwordless_session.state)
+      returns:
+        - (PasswordlessSessionStruct)
+  go:
+    - key: CreateSession
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: passwordless.CreateSession()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: passwordless.CreateSessionOpts
+          expanded: true
+          properties:
+            - (PasswordlessSession.Email)
+            - key: Type
+              type: passwordless.PasswordlessSessionType
+              description: (create_passwordless_session.type)
+            - key: RedirectURI
+              type: string
+              optional: true
+              description: (create_passwordless_session.redirect_uri)
+            - key: ExpiresIn
+              type: int
+              optional: true
+              description: (create_passwordless_session.expires_in)
+            - key: State
+              type: string
+              optional: true
+              description: (create_passwordless_session.state)
+      returns:
+        - key: session
+          type: passwordless.PasswordlessSession
+          description: (passwordless_session.self)
+        - (err)
+  php:
+    - key: createSession
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: $passwordless->createSession()
+      parameters:
+        - key: email
+          type: string
+          description: (create_passwordless_session.email)
+        - key: type
+          type: '"MagicLink"'
+          description: (create_passwordless_session.type)
+        - key: redirectUri
+          type: string
+          optional: true
+          description: (create_passwordless_session.redirect_uri)
+        - key: expiresIn
+          type: int
+          optional: true
+          description: (create_passwordless_session.expires_in)
+        - key: state
+          type: string
+          optional: true
+          description: (create_passwordless_session.state)
+      returns:
+        - (PasswordlessSession)
+  java:
+    - key: createSession
+      id: create_passwordless_session
+      url: /reference/magic-link/passwordless-session/create
+      title: passwordless.createSession()
+      parameters:
+        - key: options
+          type: CreateSessionOptions
+          expanded: true
+          properties:
+            - key: email
+              type: String
+              description: (create_passwordless_session.email)
+            - key: type
+              type: SessionType
+              description: (create_passwordless_session.type)
+            - key: redirectUri
+              type: String
+              optional: true
+              description: (create_passwordless_session.redirect_uri)
+            - key: expiresIn
+              type: Int
+              optional: true
+              description: (create_passwordless_session.expires_in)
+            - key: state
+              type: String
+              optional: true
+              description: (create_passwordless_session.state)
+            - key: builder()
+              type: CreateSessionOptionsBuilder
+              description: (java.builder)
+      returns:
+        - (PasswordlessSession)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/magic-link/passwordless-session/create.mdx
+---
+
+## Create Passwordless Session [Deprecated]
+
+Create a Passwordless Session for a Magic Link Connection.
+
+<CodeBlock referenceId="create_passwordless_session">
+  <CodeBlockTab title="Request" file="create-passwordless-session-request" />
+  <CodeBlockTab title="Response" file="create-passwordless-session-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx

@@ -0,0 +1,203 @@
+---
+descriptions:
+  passwordless_session:
+    self: >-
+      The [Paswordless Session](/reference/magic-link/passwordless-session)
+      object.
+    object: Distinguishes the Paswordless Session object.
+    id: The unique ID of the session.
+    email: The email address of the user for the session.
+    expires_at: The ISO-8601 datetime at which the session expires.
+    link: >
+      The link for the user to authenticate with. You can use this link to send
+      a custom email to the user, or send an email using [Email a Magic
+      Link](/reference/magic-link/passwordless-session/send-email) to the user.
+
+
+      Once a user has authenticated with the link, WorkOS issues a redirect to
+      the Environment’s default redirect URI, with a `code` parameter and, if
+      provided during [session
+      creation](/reference/magic-link/passwordless-session/create), a `state`
+      parameter.
+
+
+      Code can then be exchanged for an access token and user
+      [Profile](/reference/sso/profile). To perform this exchange, the Developer
+      should make a POST request to the `/sso/token`
+      [endpoint](/reference/sso/profile/get-profile-and-token).
+
+
+      > If the link has expired, WorkOS will issue a redirect with an `error`
+      query parameter and value of `access_denied`.
+reference:
+  curl:
+    - url: /reference/magic-link/passwordless-session
+      key: passwordless_session
+      id: passwordless_session
+      title: passwordless_session
+      properties:
+        - key: object
+          type: '"passwordless_session"'
+          description: (passwordless_session.object)
+        - key: id
+          type: string
+          description: (passwordless_session.id)
+        - key: email
+          type: string
+          description: (passwordless_session.email)
+        - key: expires_at
+          type: string
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: string
+          description: (passwordless_session.link)
+  dotnet:
+    - key: PasswordlessSession
+      id: passwordless_session
+      url: /reference/magic-link/passwordless-session
+      title: class PasswordlessSession
+      properties:
+        - key: Object
+          type: '"passwordless_session"'
+          description: (passwordless_session.object)
+        - key: Id
+          type: string
+          description: (passwordless_session.id)
+        - key: Email
+          type: string
+          description: (passwordless_session.email)
+        - key: ExpiresAt
+          type: DateTime
+          description: (passwordless_session.expires_at)
+        - key: Link
+          type: string
+          description: (passwordless_session.link)
+  python:
+    - key: PasswordlessSession
+      id: passwordless_session
+      url: /reference/magic-link/passwordless-session
+      title: PasswordlessSession
+      properties:
+        - key: object
+          type: '"passwordless_session"'
+          description: (passwordless_session.object)
+        - key: id
+          type: str
+          description: (passwordless_session.id)
+        - key: email
+          type: str
+          description: (passwordless_session.email)
+        - key: expires_at
+          type: datetime
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: str
+  js:
+    - key: PasswordlessSession
+      id: passwordless_session
+      url: /reference/magic-link/passwordless-session
+      title: interface PasswordlessSession
+      properties:
+        - key: object
+          type: string
+          description: (passwordless_session.id)
+        - key: email
+          type: string
+          description: (passwordless_session.email)
+        - key: expiresAt
+          type: Date
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: string
+          description: (passwordless_session.link)
+  ruby:
+    - url: /reference/magic-link/passwordless-session
+      key: PasswordlessSessionStruct
+      id: passwordless_session
+      title: class PasswordlessSessionStruct
+      properties:
+        - key: id
+          type: String
+          description: (passwordless_session.id)
+        - key: email
+          type: String
+          description: (passwordless_session.email)
+        - key: expires_at
+          type: String
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: String
+          description: (passwordless_session.link)
+  go:
+    - url: /reference/magic-link/passwordless-session
+      key: PasswordlessSession
+      id: passwordless_session
+      title: passwordless.PasswordlessSession
+      properties:
+        - key: ID
+          type: string
+          description: (passwordless_session.id)
+        - key: Email
+          type: string
+          description: (passwordless_session.email)
+        - key: ExpiresAt
+          type: string
+          description: (passwordless_session.expires_at)
+        - key: Link
+          type: string
+          description: (passwordless_session.link)
+  php:
+    - key: PasswordlessSession
+      id: passwordless_session
+      url: /reference/magic-link/passwordless-session
+      title: WorkOS\Resource\PasswordlessSession
+      properties:
+        - key: object
+          type: string
+          description: (passwordless_session.object)
+        - key: id
+          type: string
+          description: (passwordless_session.id)
+        - key: email
+          type: string
+          description: (passwordless_session.email)
+        - key: expiresAt
+          type: string
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: string
+          description: (passwordless_session.link)
+  java:
+    - key: PasswordlessSession
+      id: passwordless_session
+      url: /reference/magic-link/passwordless-session
+      title: class PasswordlessSession
+      properties:
+        - key: obj
+          type: '"passwordless_session"'
+          description: (passwordless_session.object)
+        - key: id
+          type: String
+          description: (passwordless_session.id)
+        - key: email
+          type: String
+          description: (passwordless_session.email)
+        - key: expiresAt
+          type: String
+          description: (passwordless_session.expires_at)
+        - key: link
+          type: String
+          description: (passwordless_session.link)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/magic-link/passwordless-session/index.mdx
+---
+
+## Passwordless Session [Deprecated]
+
+An object representing a passwordless authentication session.
+
+<CodeBlock
+  title="Example Passwordless Session"
+  file="passwordless-session"
+  referenceId="passwordless_session"
+/>

package/.docs/organized/docs/reference/magic-link/passwordless-session/send-email.mdx

@@ -0,0 +1,158 @@
+---
+descriptions:
+  send_session:
+    id: >-
+      The unique identifier of the [Passwordless
+      Session](/reference/magic-link/passwordless-session) to send an email for.
+    success: A confirmation that the Magic Link was sent.
+reference:
+  curl:
+    - key: send_session
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: '/passwordless/sessions/:id/send'
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: string
+          description: (send_session.id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: success
+              type: boolean
+              description: (send_session.success)
+  dotnet:
+    - key: SendSession
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: passwordlessService.SendSession()
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: string
+          description: (send_session.id)
+        - (cancellationToken)
+      returns:
+        - key: Task<bool>
+          description: (send_session.success)
+  python:
+    - key: send_session
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: passwordless.send_session()
+      sendsEmail: true
+      parameters:
+        - key: session_id
+          type: str
+          description: (send_session.id)
+      returns:
+        - key: success
+          type: bool
+          description: (send_session.success)
+  js:
+    - key: sendSession
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: passwordless.sendSession()
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: string
+          description: (send_session.id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: success
+              type: boolean
+              description: (send_session.success)
+  ruby:
+    - key: send_session
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: Passwordless.send_session()
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: String
+          description: (send_session.id)
+      returns:
+        - key: anonymous
+          type: Hash
+          unwrap: true
+          properties:
+            - key: success
+              type: Bool
+              description: (send_session.success)
+  go:
+    - key: SendSession
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: passwordless.SendSession()
+      sendsEmail: true
+      parameters:
+        - (ctx)
+        - key: opts
+          type: passwordless.SendSessionOpts
+          expanded: true
+          properties:
+            - key: SessionID
+              type: string
+              description: (send_session.id)
+      returns:
+        - (err)
+  php:
+    - key: sendSession
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: $passwordless->sendSession()
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: string
+          description: (send_session.id)
+      returns:
+        - key: success
+          type: bool
+          description: (send_session.success)
+  java:
+    - key: sendSession
+      id: send_session
+      url: /reference/magic-link/passwordless-session/send-email
+      title: passwordless.sendSession()
+      sendsEmail: true
+      parameters:
+        - key: id
+          type: String
+          description: (send_session.id)
+      returns:
+        - key: response
+          type: SendSessionResponse
+          expanded: true
+          properties:
+            - key: success
+              type: Boolean
+              description: (send_session.success)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/magic-link/passwordless-session/send-email.mdx
+---
+
+## Email a Magic Link [Deprecated]
+
+Email a user the Magic Link confirmation URL.
+
+<CodeBlock referenceId="send_session">
+  <CodeBlockTab
+    title="Request"
+    file="send-email-passwordless-session-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="send-email-passwordless-session-response"
+  />
+</CodeBlock>