@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/email-verification/get.mdx

@@ -0,0 +1,88 @@
+---
+reference:
+  curl:
+    - key: get_email_verification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: '/user_management/email_verification/:id'
+      type: GET
+      parameters:
+        - (email_verification.id)
+      returns:
+        - (email_verification)
+  js:
+    - key: getEmailVerification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: userManagement.getEmailVerification()
+      parameters:
+        - (EmailVerification.id)
+      returns:
+        - (EmailVerification)
+  go:
+    - key: getEmailVerification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: usermanagement.getEmailVerification()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.GetEmailVerificationOpts
+          unwrap: true
+          properties:
+            - key: EmailVerification
+              type: string
+              description: (email_verification.id)
+      returns:
+        - (EmailVerification)
+        - (err)
+  php:
+    - key: getEmailVerification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: $userManagement->getEmailVerification()
+      parameters:
+        - (EmailVerification.id)
+      returns:
+        - (EmailVerification)
+  python:
+    - key: get_email_verification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: user_management.get_email_verification()
+      parameters:
+        - key: email_verification_id
+          type: str
+          description: (email_verification.id)
+      returns:
+        - (EmailVerification)
+  ruby:
+    - key: get_email_verification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: UserManagement.get_email_verification()
+      parameters:
+        - (EmailVerification.id)
+      returns:
+        - (EmailVerification)
+  java:
+    - key: getEmailVerification
+      id: get_email_verification
+      url: /reference/user-management/email-verification/get
+      title: userManagement.getEmailVerification()
+      parameters:
+        - (EmailVerification.id)
+      returns:
+        - (EmailVerification)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/email-verification/get.mdx
+---
+
+## Get an email verification code
+
+Get the details of an existing email verification code that can be used to send an email to a user for verification.
+
+<CodeBlock referenceId="get_email_verification">
+  <CodeBlockTab title="Request" file="get-email-verification-request" />
+  <CodeBlockTab title="Response" file="get-email-verification-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/email-verification/index.mdx

@@ -0,0 +1,227 @@
+---
+descriptions:
+  email_verification:
+    self: >-
+      The corresponding [email
+      verification](/reference/user-management/email-verification) object.
+    object: Distinguishes the email verification object.
+    id: The unique ID of the email verification code.
+    user_id: The unique ID of the user.
+    email: The email address of the user.
+    expires_at: The timestamp when the email verification code expires.
+    code: The code used to verify the email.
+    created_at: The timestamp when the email verification code was created.
+    updated_at: The timestamp when the email verification code was last updated.
+reference:
+  curl:
+    - url: /reference/user-management/email-verification
+      key: email_verification
+      id: email_verification
+      title: email_verification
+      properties:
+        - key: id
+          type: string
+          description: (email_verification.id)
+        - key: user_id
+          type: string
+          description: (email_verification.user_id)
+        - key: email
+          type: string
+          description: (email_verification.email)
+        - key: expires_at
+          type: string
+          description: (email_verification.expires_at)
+        - key: code
+          type: string
+          description: (email_verification.code)
+        - key: created_at
+          type: string
+          description: (email_verification.created_at)
+        - key: updated_at
+          type: string
+          description: (email_verification.updated_at)
+  js:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: interface EmailVerification
+      properties:
+        - key: object
+          type: '"email_verification"'
+          description: (email_verification.object)
+        - key: id
+          type: string
+          description: (email_verification.id)
+        - key: userId
+          type: string
+          description: (email_verification.user_id)
+        - key: email
+          type: string
+          description: (email_verification.email)
+        - key: expiresAt
+          type: string
+          description: (email_verification.expires_at)
+        - key: code
+          type: string
+          description: (email_verification.code)
+        - key: createdAt
+          type: string
+          description: (email_verification.created_at)
+        - key: updatedAt
+          type: string
+          description: (email_verification.updated_at)
+  go:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: usermanagement.EmailVerification
+      properties:
+        - key: ID
+          type: string
+          description: (email_verification.id)
+        - key: UserId
+          type: string
+          description: (email_verification.user_id)
+        - key: Email
+          type: string
+          description: (email_verification.email)
+        - key: ExpiresAt
+          type: string
+          description: (email_verification.expires_at)
+        - key: Code
+          type: string
+          description: (email_verification.code)
+        - key: CreatedAt
+          type: string
+          description: (email_verification.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (email_verification.updated_at)
+  php:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: WorkOS\Resource\EmailVerification
+      properties:
+        - key: object
+          type: '"email_verification"'
+          description: (email_verification.object)
+        - key: id
+          type: string
+          description: (email_verification.id)
+        - key: userId
+          type: string
+          description: (email_verification.user_id)
+        - key: email
+          type: string
+          description: (email_verification.email)
+        - key: expiresAt
+          type: string
+          description: (email_verification.expires_at)
+        - key: code
+          type: string
+          description: (email_verification.code)
+        - key: createdAt
+          type: string
+          description: (email_verification.created_at)
+        - key: updatedAt
+          type: string
+          description: (email_verification.updated_at)
+  python:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: EmailVerification
+      properties:
+        - key: id
+          type: str
+          description: (email_verification.id)
+        - key: user_id
+          type: str
+          description: (email_verification.user_id)
+        - key: email
+          type: str
+          description: (email_verification.email)
+        - key: expires_at
+          type: str
+          description: (email_verification.expires_at)
+        - key: code
+          type: str
+          description: (email_verification.code)
+        - key: created_at
+          type: str
+          description: (email_verification.created_at)
+        - key: updated_at
+          type: str
+          description: (email_verification.updated_at)
+  ruby:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: class EmailVerification
+      properties:
+        - key: id
+          type: String
+          description: (email_verification.id)
+        - key: user_id
+          type: String
+          description: (email_verification.user_id)
+        - key: email
+          type: String
+          description: (email_verification.email)
+        - key: expires_at
+          type: String
+          description: (email_verification.expires_at)
+        - key: code
+          type: String
+          description: (email_verification.code)
+        - key: created_at
+          type: String
+          description: (email_verification.created_at)
+        - key: updated_at
+          type: String
+          description: (email_verification.updated_at)
+  java:
+    - url: /reference/user-management/email-verification
+      key: EmailVerification
+      id: email_verification
+      title: class EmailVerification
+      properties:
+        - key: id
+          type: String
+          description: (email_verification.id)
+        - key: userId
+          type: String
+          description: (email_verification.user_id)
+        - key: email
+          type: String
+          description: (email_verification.email)
+        - key: expiresAt
+          type: String
+          description: (email_verification.expires_at)
+        - key: code
+          type: String
+          description: (email_verification.code)
+        - key: createdAt
+          type: String
+          description: (email_verification.created_at)
+        - key: updatedAt
+          type: String
+          description: (email_verification.updated_at)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/email-verification/index.mdx
+---
+
+---
+
+# Email verification
+
+Email verification is a security feature that requires users to verify their email address before they can sign in to your application. It is enabled by default.
+
+Users signing in with Magic Auth, Google OAuth, Apple OAuth, or SSO are automatically verified. For other authentication methods, an email verification flow is required to confirm that the user’s email address belongs to them.
+
+<CodeBlock
+  title="Example email verification"
+  referenceId="email_verification"
+  file="email-verification"
+/>

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

@@ -0,0 +1,74 @@
+---
+descriptions:
+  identity:
+    type: The type of the identity.
+    idp_id: The unique ID of the user in the external identity provider.
+    provider: |
+      The type of OAuth provider for the identity.
+
+      Possible values:
+      - `AppleOAuth`
+      - `GitHubOAuth`
+      - `GoogleOAuth`
+      - `MicrosoftOAuth`
+reference:
+  json:
+    - url: /reference/user-management/identity
+      key: identity
+      id: identity
+      title: identity
+      properties:
+        - key: idp_id
+          type: string
+          description: (identity.idp_id)
+        - key: type
+          type: '"OAuth"'
+          description: (identity.type)
+        - key: provider
+          type: enum
+          description: (identity.provider)
+  java:
+    - url: /reference/user-management/identity
+      key: Identity
+      id: identity
+      title: class Identity
+      properties:
+        - key: idpId
+          type: String
+          description: (identity.idp_id)
+        - key: type
+          type: '"OAuth"'
+          description: (identity.type)
+        - key: provider
+          type: IdentityProviderEnumType
+          description: (identity.provider)
+  js:
+    - url: /reference/user-management/identity
+      key: Identity
+      id: identity
+      title: interface Identity
+      properties:
+        - key: idpId
+          type: String
+          description: (identity.idp_id)
+        - key: type
+          type: '"OAuth"'
+          description: (identity.type)
+        - key: provider
+          type: '"AppleOAuth" | "GoogleOAuth" | "GitHubOAuth" | "MicrosoftOAuth"'
+          description: (identity.provider)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/identity/index.mdx
+---
+
+---
+
+# Identities
+
+Represents [User](/reference/user-management/user) identities obtained from external identity providers.
+
+When a user authenticates using an external provider like [Google OAuth](/integrations/google-oauth), information from that provider will be made available as one of the user's Identities. You can read more about the process in our [identity linking guide](/user-management/identity-linking).
+
+> Applications should check the `type` before making assumptions about the shape of the identity. Currently only `OAuth` identities are supported, but more types may be added in the future.
+
+<CodeBlock title="Identity" referenceId="identity" file="identity" />

package/.docs/organized/docs/reference/user-management/identity/list.mdx

@@ -0,0 +1,52 @@
+---
+reference:
+  curl:
+    - key: list_identities
+      id: list_identities
+      url: /reference/user-management/identity/list
+      title: '/user_management/users/:id/identities'
+      type: GET
+      parameters:
+        - (user.id)
+      returns:
+        - key: identities
+          type: array
+          description: The array of identities associated with the user.
+  java:
+    - key: getUserIdentities
+      id: list_identities
+      url: /reference/user-management/identity/list
+      title: userManagement.getUserIdentities()
+      parameters:
+        - key: userId
+          type: String
+          description: (user.id)
+      returns:
+        - key: identities
+          type: 'Identity[]'
+          description: The array of identities associated with the user.
+  js:
+    - key: getUserIdentities
+      id: list_identities
+      url: /reference/user-management/identity/list
+      title: userManagement.getUserIdentities()
+      parameters:
+        - key: userId
+          type: String
+          description: (user.id)
+      returns:
+        - key: identities
+          type: 'Identity[]'
+          description: The array of identities associated with the user.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/identity/list.mdx
+---
+
+## Get user identities
+
+Get a list of identities associated with the user. A user can have multiple associated identities after going through [identity linking](/user-management/identity-linking). Currently only OAuth identities are supported. More provider types may be added in the future.
+
+<CodeBlock referenceId="list_identities">
+  <CodeBlockTab title="Request" file="get-identities-request" />
+  <CodeBlockTab title="Response" file="get-identities-response" />
+</CodeBlock>

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

@@ -0,0 +1,13 @@
+---
+descriptions:
+  challenge_response:
+    token: The email verification token.
+    user: 'The corresponding [User](/reference/user-management/user) object.'
+originalPath: .tmp-workos-clone/packages/docs/content/reference/user-management/index.mdx
+---
+
+# User Management
+
+A set of user authentication and organization security features designed to provide a fast, scalable integration while handling all of the user management complexity that comes with advanced business and customer needs.
+
+To automatically respond to User Management activities, like authentication and changes related to the users, use the corresponding [events](/events).

package/.docs/organized/docs/reference/user-management/invitation/accept.mdx

@@ -0,0 +1,39 @@
+---
+reference:
+  curl:
+    - key: accept_invitation
+      id: accept_invitation
+      url: /reference/user-management/invitation/accept
+      title: '/user_management/invitations/:id/accept'
+      type: POST
+      parameters:
+        - (invitation.id)
+      returns:
+        - (invitation)
+  js:
+    - key: acceptInvitation
+      id: accept_invitation
+      url: /reference/user-management/invitation/accept
+      title: userManagement.acceptInvitation()
+      parameters:
+        - (Invitation.id)
+      returns:
+        - (Invitation)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/invitation/accept.mdx
+---
+
+## Accept an invitation
+
+Accepts an invitation and, if linked to an organization, activates the user’s membership in that organization.
+
+In most cases, use existing authentication methods like [`authenticateWithCode`](/reference/user-management/authentication/code), which also accept an invitation token. These methods offer the same functionality (invitation acceptance and membership activation) while also signing the user in.
+
+This method is useful for apps requiring a highly customized invitation flow, as it focuses solely on handling invitations without authentication. It’s also helpful when users can be invited to multiple organizations and need a way to accept invitations after signing in.
+
+Your application should verify that the invitation is intended for the user accepting it. For example, by fetching the invitation using the [find-by-token endpoint](/reference/user-management/invitation/find-by-token) and ensuring the email matches the email address of the accepting user.
+
+<CodeBlock referenceId="accept_invitation">
+  <CodeBlockTab title="Request" file="accept-invitation-request" />
+  <CodeBlockTab title="Response" file="accept-invitation-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/invitation/find-by-token.mdx

@@ -0,0 +1,87 @@
+---
+reference:
+  curl:
+    - key: find_invitation_by_token
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: '/user_management/invitations/by_token/:token'
+      type: GET
+      parameters:
+        - (invitation.token)
+      returns:
+        - (invitation)
+  js:
+    - key: findInvitationByToken
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: userManagement.findInvitationByToken()
+      parameters:
+        - (Invitation.token)
+      returns:
+        - (Invitation)
+  go:
+    - key: FindInvitationByToken
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: usermanagement.FindInvitationByToken()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.FindInvitationByTokenOpts
+          unwrap: true
+          properties:
+            - key: InvitationToken
+              type: string
+              description: (invitation.token)
+      returns:
+        - (Invitation)
+  php:
+    - key: findInvitationByToken
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: $userManagement->findInvitationByToken()
+      parameters:
+        - (Invitation.token)
+      returns:
+        - (Invitation)
+  python:
+    - key: find_invitation_by_token
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: user_management.find_invitation_by_token()
+      parameters:
+        - key: invitation_token
+          type: str
+          description: (invitation.token)
+      returns:
+        - (Invitation)
+  ruby:
+    - key: find_invitation_by_token
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: UserManagement.find_invitation_by_token()
+      parameters:
+        - (Invitation.token)
+      returns:
+        - (Invitation)
+  java:
+    - key: findInvitationByToken
+      id: find_invitation_by_token
+      url: /reference/user-management/invitation/find-by-token
+      title: userManagement.findInvitationByToken()
+      parameters:
+        - (Invitation.token)
+      returns:
+        - (Invitation)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/invitation/find-by-token.mdx
+---
+
+## Find an invitation by token
+
+Retrieve an existing invitation using the token.
+
+<CodeBlock referenceId="find_invitation_by_token">
+  <CodeBlockTab title="Request" file="find-invitation-by-token-request" />
+  <CodeBlockTab title="Response" file="find-invitation-by-token-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/invitation/get.mdx

@@ -0,0 +1,87 @@
+---
+reference:
+  curl:
+    - key: get_invitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: '/user_management/invitations/:id'
+      type: GET
+      parameters:
+        - (invitation.id)
+      returns:
+        - (invitation)
+  js:
+    - key: getInvitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: userManagement.getInvitation()
+      parameters:
+        - (Invitation.id)
+      returns:
+        - (Invitation)
+  go:
+    - key: getInvitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: usermanagement.GetInvitation()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.GetInvitationOpts
+          unwrap: true
+          properties:
+            - key: Invitation
+              type: string
+              description: (invitation.id)
+      returns:
+        - (Invitation)
+  php:
+    - key: getInvitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: $userManagement->getInvitation()
+      parameters:
+        - (Invitation.id)
+      returns:
+        - (Invitation)
+  python:
+    - key: get_invitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: user_management. get_invitation()
+      parameters:
+        - key: invitation_id
+          type: str
+          description: (invitation.id)
+      returns:
+        - (Invitation)
+  ruby:
+    - key: get_invitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: UserManagement.get_invitation()
+      parameters:
+        - (Invitation.id)
+      returns:
+        - (Invitation)
+  java:
+    - key: getInvitation
+      id: get_invitation
+      url: /reference/user-management/invitation/get
+      title: userManagement.getInvitation()
+      parameters:
+        - (Invitation.id)
+      returns:
+        - (Invitation)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/invitation/get.mdx
+---
+
+## Get an invitation
+
+Get the details of an existing invitation.
+
+<CodeBlock referenceId="get_invitation">
+  <CodeBlockTab title="Request" file="get-invitation-request" />
+  <CodeBlockTab title="Response" file="get-invitation-response" />
+</CodeBlock>