@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/mfa/challenge-factor.mdx

@@ -0,0 +1,170 @@
+---
+descriptions:
+  challenge_factor:
+    authentication_factor_id: The unique ID of the Authentication Factor to be challenged.
+    sms_template: >-
+      Optional template for SMS messages. Only applicable for `sms` Factors. Use
+      the `{{code}}` token to inject the one-time code into the message. E.g.,
+      `Your Foo Corp one-time code is {{code}}.`
+reference:
+  curl:
+    - key: challenge_factor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: '/auth/factors/:id/challenge'
+      type: POST
+      parameters:
+        - key: authentication_factor_id
+          type: string
+          description: (challenge_factor.authentication_factor_id)
+        - key: sms_template
+          type: string
+          optional: true
+          description: (challenge_factor.sms_template)
+      returns:
+        - (authentication_challenge)
+  dotnet:
+    - key: ChallengeFactor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: mfaService.ChallengeFactor()
+      parameters:
+        - key: options
+          type: ChallengeFactorOptions
+          expanded: true
+          properties:
+            - key: FactorId
+              type: string
+              description: (challenge_factor.authentication_factor_id)
+        - (cancellationToken)
+      returns:
+        - key: Task<Challenge>
+          description: (authentication_challenge.self)
+    - key: ChallengeSmsFactorOptions
+      patternBefore: new
+      id: dotnet_challenge_sms_factor_options
+      url: /reference/mfa/challenge-factor
+      title: 'class ChallengeSmsFactorOptions : ChallengeFactorOptions'
+      properties:
+        - key: SmsTemplate
+          type: string
+  ruby:
+    - key: challenge_factor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: MFA.challenge_factor()
+      parameters:
+        - key: authentication_factor_id
+          type: String
+          description: (challenge_factor.authentication_factor_id)
+        - key: sms_template
+          type: String
+          optional: true
+          description: (challenge_factor.sms_template)
+      returns:
+        - (Challenge)
+  js:
+    - key: challengeFactor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: mfa.challengeFactor()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticationFactorId
+              type: string
+              description: (challenge_factor.authentication_factor_id)
+            - key: smsTemplate
+              type: string
+              optional: true
+              description: (challenge_factor.sms_template)
+      returns:
+        - (Challenge)
+  python:
+    - key: challenge_factor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: mfa.challenge_factor()
+      parameters:
+        - key: authentication_factor_id
+          type: str
+          description: (challenge_factor.authentication_factor_id)
+        - key: sms_template
+          type: str
+          optional: true
+          description: (challenge_factor.sms_template)
+      returns:
+        - (AuthenticationChallenge)
+  php:
+    - key: challengeFactor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: $mfa->challengeFactor()
+      parameters:
+        - key: authenticationFactorId
+          type: string
+          description: (challenge_factor.authentication_factor_id)
+        - key: smsTemplate
+          type: string
+          optional: true
+          description: (challenge_factor.sms_template)
+      returns:
+        - (AuthenticationChallenge)
+  java:
+    - key: challengeFactor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: mfa.challengeFactor()
+      parameters:
+        - key: options
+          type: ChallengeFactorOptions
+          expanded: true
+          properties:
+            - key: authenticationFactorId
+              type: String
+              description: (challenge_factor.authentication_factor_id)
+            - key: smsTemplate
+              type: String
+              optional: true
+              description: (challenge_factor.sms_template)
+            - key: builder()
+              type: ChallengeFactorOptionsBuilder
+              description: (java.builder)
+      returns:
+        - (Challenge)
+  go:
+    - key: ChallengeFactor
+      id: challenge_factor
+      url: /reference/mfa/challenge-factor
+      title: mfa.ChallengeFactor()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: mfa.ChallengeFactorOpts
+          expanded: true
+          properties:
+            - key: FactorID
+              type: string
+              description: (challenge_factor.authentication_factor_id)
+            - key: SMSTemplate
+              type: string
+              optional: true
+              description: (challenge_factor.sms_template)
+      returns:
+        - key: challenge
+          type: mfa.Challenge
+          description: (authentication_challenge.self)
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/challenge-factor.mdx
+---
+
+## Challenge Factor
+
+Creates a Challenge for an Authentication Factor.
+
+<CodeBlock referenceId="challenge_factor">
+  <CodeBlockTab title="Request" file="challenge-factor-request" />
+  <CodeBlockTab title="Response" file="challenge-factor-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/mfa/delete-factor.mdx

@@ -0,0 +1,93 @@
+---
+reference:
+  curl:
+    - key: delete_factor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: '/auth/factors/:id'
+      type: DELETE
+      parameters:
+        - (authentication_factor.id)
+  js:
+    - key: deleteFactor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: mfa.deleteFactor()
+      parameters:
+        - (Factor.id)
+  php:
+    - key: deleteFactor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: $mfa->deleteFactor()
+      parameters:
+        - key: authenticationFactorId
+          type: string
+          description: (authentication_factor.id)
+  java:
+    - key: deleteFactor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: mfa.deleteFactor()
+      parameters:
+        - key: authenticationFactorId
+          type: String
+          description: (authentication_factor.id)
+  ruby:
+    - key: delete_factor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: MFA.delete_factor()
+      parameters:
+        - key: id
+          type: String
+          description: (authentication_factor.id)
+  python:
+    - key: delete_factor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: mfa.delete_factor()
+      parameters:
+        - key: authentication_factor_id
+          type: str
+          description: (authentication_factor.id)
+  dotnet:
+    - key: DeleteFactor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: mfaService.DeleteFactor()
+      parameters:
+        - key: id
+          type: string
+          description: (authentication_factor.id)
+        - (cancellationToken)
+      returns:
+        - (Task)
+  go:
+    - key: DeleteFactor
+      id: delete_factor
+      url: /reference/mfa/delete-factor
+      title: mfa.DeleteFactor()
+      properties:
+        - (ctx)
+        - key: opts
+          type: mfa.DeleteFactorOpts
+          expanded: true
+          properties:
+            - key: FactorID
+              type: string
+              description: (authentication_factor.id)
+      returns:
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/delete-factor.mdx
+---
+
+## Delete Factor
+
+Permanently deletes an Authentication Factor. It cannot be undone.
+
+<CodeBlock
+  title="Request"
+  referenceId="delete_factor"
+  file="delete-factor-request"
+/>

package/.docs/organized/docs/reference/mfa/enroll-factor.mdx

@@ -0,0 +1,241 @@
+---
+descriptions:
+  enroll_factor:
+    type: |
+      The type of factor you wish to enroll.
+        - `totp`
+        - `sms`
+    totp_issuer: >-
+      An identifier for the organization issuing the challenge. Should be the
+      name of your application or company. Required when type is `totp`.
+    totp_user: >-
+      An identifier for the user. Used by authenticator apps to label
+      connections. Required when type is `totp`.
+    phone_number: >-
+      A valid phone number for an SMS-enabled device. Required when type is
+      `sms`.
+reference:
+  curl:
+    - key: enroll_factor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: /auth/factors/enroll
+      type: POST
+      parameters:
+        - key: type
+          type: |
+            "totp" | "sms"
+          description: (enroll_factor.type)
+        - key: totp_issuer
+          type: string
+          description: (enroll_factor.totp_issuer)
+        - key: totp_user
+          type: string
+          description: (enroll_factor.totp_user)
+        - key: phone_number
+          type: string
+          description: (enroll_factor.phone_number)
+      returns:
+        - (authentication_factor)
+  dotnet:
+    - key: EnrollFactor
+      id: enroll_factor
+      url: /reference/mfa/Enroll-factor
+      title: mfaService.EnrollFactor()
+      parameters:
+        - key: options
+          type: EnrollFactorOptions
+          description: >
+            Create an instance of `EnrollTotpFactorOptions` or
+            `EnrollSmsFactorOptions` to enroll an Authentication Factor with
+            TOTP or SMS respectively.
+
+
+            ---
+
+
+            `EnrollTotpFactorOptions` accepts two parameters:
+
+            - `issuer` – an identifier for the organization issuing the
+            challenge. Should be the name of your application or company.
+
+            - `user` – an identifier for the user. Used by authenticator apps to
+            label connections.
+
+
+            ---
+
+
+            `EnrollSmsFactorOptions` accepts one parameter – a valid phone
+            number for an SMS-enabled device.
+        - (cancellationToken)
+      returns:
+        - key: Task<Factor>
+          description: (authentication_factor.self)
+  ruby:
+    - key: enroll_factor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: MFA.enroll_factor()
+      parameters:
+        - key: type
+          type: |
+            "totp" | "sms"
+          description: (enroll_factor.type)
+        - key: totp_issuer
+          type: String
+          optional: true
+          description: (enroll_factor.totp_issuer)
+        - key: totp_user
+          type: String
+          optional: true
+          description: (enroll_factor.totp_user)
+        - key: phone_number
+          type: String
+          optional: true
+          description: (enroll_factor.phone_number)
+      returns:
+        - (Factor)
+  python:
+    - key: enroll_factor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: mfa.enroll_factor()
+      parameters:
+        - key: type
+          type: |
+            "totp" | "sms"
+          description: (enroll_factor.type)
+        - key: totp_issuer
+          type: str
+          optional: true
+          description: (enroll_factor.totp_issuer)
+        - key: totp_user
+          type: str
+          optional: true
+          description: (enroll_factor.totp_user)
+        - key: phone_number
+          type: str
+          optional: true
+          description: (enroll_factor.phone_number)
+      returns:
+        - (AuthenticationFactor)
+  js:
+    - key: enrollFactor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: mfa.enrollFactor()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: type
+              type: |
+                "totp" | "sms"
+              description: (enroll_factor.type)
+            - key: issuer
+              type: string
+              description: (enroll_factor.totp_issuer)
+            - key: user
+              type: string
+              description: (enroll_factor.totp_user)
+            - key: phoneNumber
+              type: string
+              description: (enroll_factor.phone_number)
+      returns:
+        - (Factor)
+  php:
+    - key: enrollFactor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: $mfa->enrollFactor()
+      parameters:
+        - key: type
+          type: |
+            "totp"|"sms"
+          description: (enroll_factor.type)
+        - key: totpIssuer
+          type: string
+          optional: true
+          description: (enroll_factor.totp_issuer)
+        - key: totpUser
+          type: string
+          optional: true
+          description: (enroll_factor.totp_user)
+        - key: phoneNumber
+          type: string
+          optional: true
+          description: (enroll_factor.phone_number)
+      returns:
+        - (AuthenticationFactor)
+  java:
+    - key: enrollFactor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: mfa.enrollFactor()
+      parameters:
+        - key: options
+          type: EnrollFactorOptions
+          expanded: true
+          properties:
+            - key: type
+              type: |
+                "totp" | "sms"
+              description: (enroll_factor.type)
+            - key: issuer
+              type: String
+              optional: true
+              description: (enroll_factor.totp_issuer)
+            - key: user
+              type: String
+              optional: true
+              description: (enroll_factor.totp_user)
+            - key: phoneNumber
+              type: String
+              optional: true
+              description: (enroll_factor.phone_number)
+            - key: builder()
+              type: EnrollFactorOptionsBuilder
+              description: (java.builder)
+      returns:
+        - (Factor)
+  go:
+    - key: EnrollFactor
+      id: enroll_factor
+      url: /reference/mfa/enroll-factor
+      title: mfa.EnrollFactor()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: mfa.EnrollFactorOpts
+          expanded: true
+          properties:
+            - key: Type
+              type: mfa.FactorType
+              description: (enroll_factor.type)
+            - key: TOTPIssuer
+              type: string
+              description: (enroll_factor.totp_issuer)
+            - key: TOTPUser
+              type: string
+              description: (enroll_factor.totp_user)
+            - key: PhoneNumber
+              type: string
+              description: (enroll_factor.phone_number)
+      returns:
+        - key: enroll
+          type: mfa.Factor
+          description: (authentication_factor.self)
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/enroll-factor.mdx
+---
+
+## Enroll Factor
+
+Enrolls an Authentication Factor to be used as an additional factor of authentication. The returned ID should be used to create an authentication Challenge.
+
+<CodeBlock referenceId="enroll_factor">
+  <CodeBlockTab title="Request" file="enroll-factor-request" />
+  <CodeBlockTab title="Response" file="enroll-factor-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/mfa/get-factor.mdx

@@ -0,0 +1,108 @@
+---
+reference:
+  curl:
+    - key: get_factor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: '/auth/factors/:id'
+      type: GET
+      parameters:
+        - (authentication_factor.id)
+      returns:
+        - (authentication_factor)
+  js:
+    - key: getFactor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: mfa.getFactor()
+      parameters:
+        - (Factor.id)
+      returns:
+        - (Factor)
+  php:
+    - key: getFactor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: $mfa->getFactor()
+      parameters:
+        - key: authenticationFactorId
+          type: string
+          description: (authentication_factor.id)
+      returns:
+        - (AuthenticationFactor)
+  java:
+    - key: getFactor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: mfa.getFactor()
+      parameters:
+        - key: authenticationFactorId
+          type: String
+          description: (authentication_factor.id)
+      returns:
+        - (Factor)
+  ruby:
+    - key: get_factor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: MFA.get_factor()
+      parameters:
+        - key: id
+          type: String
+          description: (authentication_factor.id)
+      returns:
+        - (Factor)
+  python:
+    - key: get_factor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: mfa.get_factor()
+      parameters:
+        - key: authentication_factor_id
+          type: str
+          description: (authentication_factor.id)
+      returns:
+        - (AuthenticationFactor)
+  dotnet:
+    - key: GetFactor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: mfaService.GetFactor()
+      parameters:
+        - key: id
+          type: string
+          description: (authentication_factor.id)
+        - (cancellationToken)
+      returns:
+        - key: Task<Factor>
+          description: (authentication_factor.self)
+  go:
+    - key: GetFactor
+      id: get_factor
+      url: /reference/mfa/get-factor
+      title: mfa.GetFactor()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: mfa.GetFactorOpts
+          expanded: true
+          properties:
+            - key: ID
+              type: string
+              description: (authentication_factor.id)
+      returns:
+        - key: factor
+          type: mfa.Factor
+          description: (authentication_factor.self)
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/get-factor.mdx
+---
+
+## Get Factor
+
+Gets an Authentication Factor.
+
+<CodeBlock referenceId="get_factor">
+  <CodeBlockTab title="Request" file="get-factor-request" />
+  <CodeBlockTab title="Response" file="get-factor-response" />
+</CodeBlock>

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

@@ -0,0 +1,8 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/index.mdx
+---
+# Multi-Factor Authentication
+
+The multi-factor authentication (MFA) API can be used to add additional factors of authentication to existing authentication strategies.
+
+The API currently supports both time-based one-time passwords (TOTP) and SMS factors.