@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/mfa/authentication-factor.mdx

@@ -0,0 +1,324 @@
+---
+descriptions:
+  user_management_authentication_factor:
+    self: >-
+      The [authentication
+      factor](/reference/user-management/mfa/authentication-factor) object.
+    object: Distinguishes the authentication factor object.
+    id: The unique ID of the factor.
+    created_at: The timestamp when the factor was created.
+    updated_at: The timestamp when the factor was last updated.
+    type: The type of the factor to enroll. The only available option is TOTP.
+    totp: Additional TOTP factor information.
+    totp_user: >-
+      The user’s account name displayed in their authenticator app. Defaults to
+      the user’s email.
+    totp_issuer: >-
+      Your application or company name displayed in the user’s authenticator
+      app. Defaults to your WorkOS team name.
+    totp_qr_code: Base64 encoded image containing scannable QR code.
+    totp_secret: >-
+      TOTP secret that can be manually entered into some authenticator apps in
+      place of scanning a QR code.
+    totp_uri: The `otpauth` URI that is encoded by the provided `qr_code`.
+    user_id: 'The ID of the [user](/reference/user-management/user).'
+reference:
+  curl:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: authentication_factor
+      id: authentication_factor
+      title: authentication_factor
+      properties:
+        - key: object
+          type: '"authentication_factor"'
+          description: (user_management_authentication_factor.object)
+        - key: id
+          type: string
+          description: (user_management_authentication_factor.id)
+        - key: created_at
+          type: string
+          description: (user_management_authentication_factor.created_at)
+        - key: updated_at
+          type: string
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: object
+          expanded: true
+          properties:
+            - key: issuer
+              type: string
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: string
+              description: (user_management_authentication_factor.totp_user)
+            - key: qr_code
+              type: string
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: string
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: string
+              description: (user_management_authentication_factor.totp_uri)
+        - key: user_id
+          type: string
+          description: (user_management_authentication_factor.user_id)
+  go:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: Factor
+      id: authentication_factor
+      title: mfa.Factor
+      properties:
+        - key: ID
+          type: string
+          description: (user_management_authentication_factor.id)
+        - key: CreatedAt
+          type: string
+          description: (user_management_authentication_factor.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (user_management_authentication_factor.updated_at)
+        - key: Type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: TOTP
+          type: mfa.TOTPDetails
+          expanded: true
+          properties:
+            - key: QRCode
+              type: string
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: Secret
+              type: string
+              description: (user_management_authentication_factor.totp_secret)
+            - key: URI
+              type: string
+              description: (user_management_authentication_factor.totp_uri)
+  ruby:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: Factor
+      id: authentication_factor
+      title: class Factor
+      properties:
+        - key: object
+          type: '"authentication_factor"'
+          description: (user_management_authentication_factor.object)
+        - key: id
+          type: String
+          description: (user_management_authentication_factor.id)
+        - key: created_at
+          type: String
+          description: (user_management_authentication_factor.created_at)
+        - key: updated_at
+          type: String
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: Hash
+          expanded: true
+          properties:
+            - key: issuer
+              type: String
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: String
+              description: (user_management_authentication_factor.totp_user)
+            - key: qr_code
+              type: String
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: String
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: String
+              description: (user_management_authentication_factor.totp_uri)
+        - key: user_id
+          type: string
+          description: (user_management_authentication_factor.user_id)
+  python:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: user_management_authentication_factor
+      id: user_management_authentication_factor
+      title: AuthenticationFactorTotp
+      properties:
+        - key: object
+          type: '"authentication_factor"'
+          description: (user_management_authentication_factor.object)
+        - key: id
+          type: str
+          description: (user_management_authentication_factor.id)
+        - key: created_at
+          type: str
+          description: (user_management_authentication_factor.created_at)
+        - key: updated_at
+          type: str
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: ExtendedTotpFactor
+          expanded: true
+          properties:
+            - key: issuer
+              type: str
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: str
+              description: (user_management_authentication_factor.totp_user)
+            - key: qr_code
+              type: str
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: str
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: str
+              description: (user_management_authentication_factor.totp_uri)
+        - key: user_id
+          type: string
+          description: (user_management_authentication_factor.user_id)
+  js:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: Factor
+      id: authentication_factor
+      title: interface Factor
+      properties:
+        - key: object
+          type: '"authentication_factor"'
+          description: (user_management_authentication_factor.object)
+        - key: id
+          type: string
+          description: (user_management_authentication_factor.id)
+        - key: createdAt
+          type: string
+          description: (user_management_authentication_factor.created_at)
+        - key: updatedAt
+          type: string
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: object
+          expanded: true
+          properties:
+            - key: issuer
+              type: string
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: string
+              description: (user_management_authentication_factor.totp_user)
+            - key: qrCode
+              type: string
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: string
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: string
+              description: (user_management_authentication_factor.totp_uri)
+        - key: userId
+          type: string
+          description: (user_management_authentication_factor.user_id)
+  php:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: AuthenticationFactor
+      id: authentication_factor
+      title: WorkOS\Resource\AuthenticationFactor
+      properties:
+        - key: object
+          type: '"authentication_factor"'
+          description: (user_management_authentication_factor.object)
+        - key: id
+          type: string
+          description: (user_management_authentication_factor.id)
+        - key: created_at
+          type: string
+          description: (user_management_authentication_factor.created_at)
+        - key: updated_at
+          type: string
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: array
+          expanded: true
+          properties:
+            - key: issuer
+              type: string
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: string
+              description: (user_management_authentication_factor.totp_user)
+            - key: qr_code
+              type: string
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: string
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: string
+              description: (user_management_authentication_factor.totp_uri)
+        - key: user_id
+          type: string
+          description: (user_management_authentication_factor.user_id)
+  java:
+    - url: /reference/user-management/mfa/authentication-factor
+      key: AuthenticationFactor
+      id: authentication_factor
+      title: class AuthenticationFactor
+      properties:
+        - key: id
+          type: String
+          description: (user_management_authentication_factor.id)
+        - key: createdAt
+          type: String
+          description: (user_management_authentication_factor.created_at)
+        - key: updatedAt
+          type: String
+          description: (user_management_authentication_factor.updated_at)
+        - key: type
+          type: '"totp"'
+          description: (user_management_authentication_factor.type)
+        - key: totp
+          type: AuthenticationTotp
+          expanded: true
+          properties:
+            - key: issuer
+              type: String
+              description: (user_management_authentication_factor.totp_issuer)
+            - key: user
+              type: String
+              description: (user_management_authentication_factor.totp_user)
+            - key: qrCode
+              type: String
+              description: (user_management_authentication_factor.totp_qr_code)
+            - key: secret
+              type: String
+              description: (user_management_authentication_factor.totp_secret)
+            - key: uri
+              type: String
+              description: (user_management_authentication_factor.totp_uri)
+        - key: userId
+          type: string
+          description: (user_management_authentication_factor.user_id)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/mfa/authentication-factor.mdx
+---
+
+## Authentication factor
+
+Represents an authentication factor.
+
+<CodeBlock
+  title="Authentication factor"
+  file="authentication-factor"
+  referenceId="authentication_factor"
+/>

package/.docs/organized/docs/reference/user-management/mfa/enroll-auth-factor.mdx

@@ -0,0 +1,296 @@
+---
+descriptions:
+  enroll_auth_factor:
+    user_id: The unique ID of the user to enroll the auth factor.
+    type: The type of the factor to enroll. The only available option is TOTP.
+    totp_issuer: >-
+      Your application or company name displayed in the user’s authenticator
+      app. Defaults to your WorkOS team name.
+    totp_user: >-
+      The user’s account name displayed in their authenticator app. Defaults to
+      the user’s email.
+    totp_secret: "The Base32-encoded shared secret for TOTP factors. This can be provided when creating the auth factor, otherwise it will be generated. The algorithm used to derive TOTP codes is sha1, the code length is 6 digits, and the timestep is 30 seconds –\_the secret must be compatible with these parameters."
+    factor: >-
+      The [authentication
+      factor](/reference/user-management/mfa/authentication-factor) object that
+      represents the additional authentication method used on top of the
+      existing authentication strategy.
+    challenge: >-
+      The [authentication
+      challenge](/reference/user-management/mfa/authentication-challenge) object
+      that is used to complete the authentication process.
+reference:
+  curl:
+    - key: enroll_auth_factor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: '/user_management/users/:id/auth_factors'
+      type: POST
+      parameters:
+        - key: id
+          type: string
+          description: (enroll_auth_factor.user_id)
+        - key: type
+          type: '"totp"'
+          description: (enroll_auth_factor.type)
+        - key: totp_issuer
+          type: string
+          optional: true
+          description: (enroll_auth_factor.totp_issuer)
+        - key: totp_user
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_user)
+        - key: totp_secret
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: challenge
+              type: authentication_challenge
+              description: (enroll_auth_factor.challenge)
+            - key: factor
+              type: authentication_factor
+              description: (enroll_auth_factor.factor)
+  js:
+    - key: enrollAuthFactor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: userManagement.enrollAuthFactor()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: userId
+              type: string
+              description: (enroll_auth_factor.user_id)
+            - key: type
+              type: '"totp"'
+              description: (enroll_auth_factor.type)
+            - key: totpIssuer
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_issuer)
+            - key: totpUser
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_user)
+            - key: totpSecret
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticationChallenge
+              type: Challenge
+              description: (enroll_auth_factor.challenge)
+            - key: authenticationFactor
+              type: Factor
+              description: (enroll_auth_factor.factor)
+  python:
+    - key: enroll_auth_factor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: user_management.enroll_auth_factor()
+      parameters:
+        - key: user_id
+          type: str
+          description: (enroll_auth_factor.user_id)
+        - key: type
+          type: '"totp"'
+          description: (enroll_auth_factor.type)
+        - key: totp_issuer
+          type: str
+          optional: true
+          description: (enroll_auth_factor.totp_issuer)
+        - key: totp_user
+          optional: true
+          type: str
+          description: (enroll_auth_factor.totp_user)
+        - key: totp_secret
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: AuthenticationFactorTotpAndChallengeResponse
+          unwrap: true
+          properties:
+            - key: authentication_challenge
+              type: AuthenticationChallenge
+              description: (enroll_auth_factor.challenge)
+            - key: authentication_factor
+              type: AuthenticationFactorTotpExtended
+              description: (enroll_auth_factor.factor)
+  go:
+    - key: EnrollAuthFactor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: usermanagement.EnrollAuthFactor()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.EnrollAuthFactorOpts
+          unwrap: true
+          properties:
+            - key: User
+              type: string
+              description: (enroll_auth_factor.user_id)
+            - key: Type
+              type: '"totp"'
+              description: (enroll_auth_factor.type)
+            - key: TOTPIssuer
+              type: string
+              optional: true
+              description: (enroll_auth_factor.totp_issuer)
+            - key: TOTPUser
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_user)
+            - key: TOTPSecret
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: response
+          type: EnrollAuthFactorResponse
+          unwrap: true
+          properties:
+            - key: Challenge
+              type: Challenge
+              description: (enroll_auth_factor.challenge)
+            - key: Factor
+              type: Factor
+              description: (enroll_auth_factor.factor)
+        - (err)
+  php:
+    - key: enrollAuthFactor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: $userManagement->enrollAuthFactor()
+      parameters:
+        - key: id
+          type: string
+          description: (enroll_auth_factor.user_id)
+        - key: type
+          type: string
+          description: (enroll_auth_factor.type)
+        - key: totpIssuer
+          type: string
+          optional: true
+          description: (enroll_auth_factor.totp_issuer)
+        - key: totpUser
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_user)
+        - key: totpSecret
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authenticationChallenge
+              type: Challenge
+              description: (enroll_auth_factor.challenge)
+            - key: authenticationFactor
+              type: Factor
+              description: (enroll_auth_factor.factor)
+  ruby:
+    - key: enroll_auth_factor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: UserManagement.enroll_auth_factor()
+      parameters:
+        - key: user_id
+          type: String
+          description: (enroll_auth_factor.user_id)
+        - key: type
+          type: '"totp"'
+          description: (enroll_auth_factor.type)
+        - key: totp_issuer
+          optional: true
+          type: String
+          description: (enroll_auth_factor.totp_issuer)
+        - key: totp_user
+          optional: true
+          type: String
+          description: (enroll_auth_factor.totp_user)
+        - key: totp_secret
+          optional: true
+          type: string
+          description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: authentication_challenge
+              type: Challenge
+              description: (enroll_auth_factor.challenge)
+            - key: authentication_factor
+              type: Factor
+              description: (enroll_auth_factor.factor)
+  java:
+    - key: enrollAuthFactor
+      id: enroll_auth_factor
+      url: /reference/user-management/mfa/enroll-auth-factor
+      title: userManagement.enrollAuthFactor()
+      parameters:
+        - key: id
+          type: String
+          description: (enroll_auth_factor.user_id)
+        - key: options
+          type: EnrolledAuthenticationFactorOptions
+          optional: true
+          unwrap: true
+          properties:
+            - key: type
+              type: '"totp"'
+              description: (enroll_auth_factor.type)
+            - key: totpIssuer
+              optional: true
+              type: String
+              description: (enroll_auth_factor.totp_issuer)
+            - key: totpUser
+              optional: true
+              type: String
+              description: (enroll_auth_factor.totp_user)
+            - key: totpSecret
+              optional: true
+              type: string
+              description: (enroll_auth_factor.totp_secret)
+      returns:
+        - key: anonymous
+          type: EnrolledAuthenticationFactor
+          unwrap: true
+          properties:
+            - key: challenge
+              type: AuthenticationChallenge
+              description: (enroll_auth_factor.challenge)
+            - key: factor
+              type: AuthenticationFactor
+              description: (enroll_auth_factor.factor)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/mfa/enroll-auth-factor.mdx
+---
+
+## Enroll an authentication factor
+
+Enrolls a user in a new authentication factor.
+
+<CodeBlock
+  title="Request"
+  referenceId="enroll_auth_factor"
+  file="enroll-auth-factor"
+/>

package/.docs/organized/docs/reference/user-management/mfa/index.mdx

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