@workos/mcp-docs-server 0.1.0

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

@@ -0,0 +1,322 @@
+---
+descriptions:
+  user:
+    self: 'The corresponding [user](/reference/user-management/user) object.'
+    object: Distinguishes the user object.
+    id: The unique ID of the user.
+    email: The email address of the user.
+    password: The password of the user.
+    first_name: The first name of the user.
+    last_name: The last name of the user.
+    email_verified: Whether the user’s email has been verified.
+    profile_picture_url: |
+      A URL reference to an image representing the user.
+
+      Currently, this URL will be present for users who have a profile picture
+      from a linked Google or GitHub OAuth identity. New image sources may be
+      added in the future.
+    last_sign_in_at: The timestamp when the user last signed in.
+    external_id: The external ID of the user.
+    metadata: >
+      Object containing [metadata](/user-management/metadata) key/value pairs
+      associated with the user.
+    created_at: The timestamp when the user was created.
+    updated_at: The timestamp when the user was last updated.
+reference:
+  curl:
+    - url: /reference/user-management/user
+      key: user
+      id: user
+      title: user
+      properties:
+        - key: object
+          type: '"user"'
+          description: (user.object)
+        - key: id
+          type: string
+          description: (user.id)
+        - key: email
+          type: string
+          description: (user.email)
+        - key: first_name
+          optional: true
+          type: string
+          description: (user.first_name)
+        - key: last_name
+          optional: true
+          type: string
+          description: (user.last_name)
+        - key: email_verified
+          type: boolean
+          description: (user.email_verified)
+        - key: profile_picture_url
+          optional: true
+          type: string
+          description: (user.profile_picture_url)
+        - key: last_sign_in_at
+          optional: true
+          type: string
+          description: (user.last_sign_in_at)
+        - key: external_id
+          optional: true
+          type: string
+          description: (user.external_id)
+        - key: metadata
+          type: object
+          description: (user.metadata)
+        - key: created_at
+          type: string
+          description: (user.created_at)
+        - key: updated_at
+          type: string
+          description: (user.updated_at)
+  js:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: interface User
+      properties:
+        - key: object
+          type: '"user"'
+          description: (user.object)
+        - key: id
+          type: string
+          description: (user.id)
+        - key: email
+          type: string
+          description: (user.email)
+        - key: firstName
+          optional: true
+          type: string
+          description: (user.first_name)
+        - key: lastName
+          optional: true
+          type: string
+          description: (user.last_name)
+        - key: emailVerified
+          type: boolean
+          description: (user.email_verified)
+        - key: profilePictureUrl
+          type: string
+          optional: true
+          description: (user.profile_picture_url)
+        - key: lastSignInAt
+          optional: true
+          type: string
+          description: (user.last_sign_in_at)
+        - key: externalId
+          optional: true
+          type: string
+          description: (user.external_id)
+        - key: metadata
+          type: object
+          description: (user.metadata)
+        - key: createdAt
+          type: string
+          description: (user.created_at)
+        - key: updatedAt
+          type: string
+          description: (user.updated_at)
+  go:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: usermanagement.User
+      properties:
+        - key: ID
+          type: string
+          description: (user.id)
+        - key: Email
+          type: string
+          description: (user.email)
+        - key: FirstName
+          optional: true
+          type: string
+          description: (user.first_name)
+        - key: LastName
+          optional: true
+          type: string
+          description: (user.last_name)
+        - key: EmailVerified
+          type: bool
+          description: (user.email_verified)
+        - key: ProfilePictureURL
+          type: string
+          optional: true
+          description: (user.profile_picture_url)
+        - key: LastSignInAt
+          optional: true
+          type: string
+          description: (user.last_sign_in_at)
+        - key: CreatedAt
+          type: string
+          description: (user.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (user.updated_at)
+  php:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: WorkOS\Resource\User
+      properties:
+        - key: object
+          type: '"user"'
+          description: (user.object)
+        - key: id
+          type: string
+          description: (user.id)
+        - key: email
+          type: string
+          description: (user.email)
+        - key: firstName
+          optional: true
+          type: string
+          description: (user.first_name)
+        - key: lastName
+          optional: true
+          type: string
+          description: (user.last_name)
+        - key: emailVerified
+          type: boolean
+          description: (user.email_verified)
+        - key: profilePictureUrl
+          type: string
+          optional: true
+          description: (user.profile_picture_url)
+        - key: lastSignInAt
+          optional: true
+          type: string
+          description: (user.last_sign_in_at)
+        - key: createdAt
+          type: string
+          description: (user.created_at)
+        - key: updatedAt
+          type: string
+          description: (user.updated_at)
+  python:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: User
+      properties:
+        - key: id
+          type: str
+          description: (user.id)
+        - key: email
+          type: str
+          description: (user.email)
+        - key: first_name
+          optional: true
+          type: str
+          description: (user.first_name)
+        - key: last_name
+          optional: true
+          type: str
+          description: (user.last_name)
+        - key: email_verified
+          type: bool
+          description: (user.email_verified)
+        - key: profile_picture_url
+          type: str
+          optional: true
+          description: (user.profile_picture_url)
+        - key: last_sign_in_at
+          optional: true
+          type: str
+          description: (user.last_sign_in_at)
+        - key: created_at
+          type: str
+          description: (user.created_at)
+        - key: updated_at
+          type: str
+          description: (user.updated_at)
+  ruby:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: class User
+      properties:
+        - key: id
+          type: String
+          description: (user.id)
+        - key: email
+          type: String
+          description: (user.email)
+        - key: first_name
+          optional: true
+          type: String
+          description: (user.first_name)
+        - key: last_name
+          optional: true
+          type: String
+          description: (user.last_name)
+        - key: email_verified
+          type: Boolean
+          description: (user.email_verified)
+        - key: profile_picture_url
+          type: String
+          optional: true
+          description: (user.profile_picture_url)
+        - key: last_sign_in_at
+          optional: true
+          type: String
+          description: (user.last_sign_in_at)
+        - key: created_at
+          type: String
+          description: (user.created_at)
+        - key: updated_at
+          type: String
+          description: (user.updated_at)
+  java:
+    - url: /reference/user-management/user
+      key: User
+      id: user
+      title: class User
+      properties:
+        - key: id
+          type: String
+          description: (user.id)
+        - key: email
+          type: String
+          description: (user.email)
+        - key: firstName
+          optional: true
+          type: String
+          description: (user.first_name)
+        - key: lastName
+          optional: true
+          type: String
+          description: (user.last_name)
+        - key: emailVerified
+          type: Boolean
+          description: (user.email_verified)
+        - key: profilePictureUrl
+          type: String
+          optional: true
+          description: (user.profile_picture_url)
+        - key: lastSignInAt
+          optional: true
+          type: String
+          description: (user.last_sign_in_at)
+        - key: createdAt
+          type: String
+          description: (user.created_at)
+        - key: updatedAt
+          type: String
+          description: (user.updated_at)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/user/index.mdx
+---
+
+---
+
+# User
+
+Represents a user identity in your application. A user can sign up in your application directly with a method like password, or they can be [JIT-provisioned](/user-management/jit-provisioning) through an organization’s SSO connection.
+
+Users may belong to [organizations](/reference/organization) as members.
+
+See the [events reference](/events/user) documentation for the user events.
+
+<CodeBlock title="User" referenceId="user" file="user" />

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

@@ -0,0 +1,260 @@
+---
+descriptions:
+  list_users:
+    type: Filter users by their type.
+    email: Filter users by their email.
+    organization_id: Filter users by the organization they are members of.
+    data: >-
+      Array of [users](/reference/user-management/user) ordered by creation
+      time.
+reference:
+  curl:
+    - key: list_users
+      id: list_users
+      url: /reference/user-management/user/list
+      title: /user_management/users
+      type: GET
+      parameters:
+        - key: email
+          optional: true
+          type: string
+          description: (list_users.email)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (list_users.organization_id)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_users.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listUsers
+      patternBefore: userManagement.
+      id: list_users
+      url: /reference/user-management/user/list
+      title: userManagement.listUsers()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: email
+              optional: true
+              type: string
+              description: (list_users.email)
+            - key: organizationId
+              optional: true
+              type: string
+              description: (list_users.organization_id)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'User[]'
+              description: (list_users.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  go:
+    - key: ListUsers
+      patternBefore: usermanagement.
+      id: list_users
+      url: /reference/user-management/user/list
+      title: usermanagement.ListUsers()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.ListUsersOpts
+          unwrap: true
+          properties:
+            - key: Email
+              optional: true
+              type: string
+              description: (list_users.email)
+            - key: Organization
+              optional: true
+              type: string
+              description: (list_users.organization_id)
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+      returns:
+        - key: users
+          type: ListUsersResponse
+          unwrap: true
+          properties:
+            - key: Data
+              type: 'User[]'
+              description: (list_users.data)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (Before)
+                - (After)
+        - (err)
+  php:
+    - key: listUsers
+      patternBefore: userManagement->
+      id: list_users
+      url: /reference/user-management/user/list
+      title: $userManagement->listUsers()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: email
+              optional: true
+              type: string
+              description: (list_users.email)
+            - key: organizationId
+              optional: true
+              type: string
+              description: (list_users.organization_id)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - (before)
+            - (after)
+            - key: data
+              type: 'User[]'
+              description: (list_users.data)
+  python:
+    - key: list_users
+      patternBefore: user_management.
+      id: list_users
+      url: /reference/user-management/user/list
+      title: user_management.list_users()
+      parameters:
+        - key: email
+          optional: true
+          type: str
+          description: (list_users.email)
+        - key: organization_id
+          optional: true
+          type: str
+          description: (list_users.organization_id)
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[User]'
+              description: (list_users.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+  ruby:
+    - key: list_users
+      id: list_users
+      url: /reference/user-management/user/list
+      title: UserManagement.list_users()
+      parameters:
+        - key: email
+          optional: true
+          type: String
+          description: (list_users.email)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (list_users.organization_id)
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[User]'
+              description: (list_users.data)
+            - key: list_metadata
+              type: Hash
+              properties:
+                - (before)
+                - (after)
+  java:
+    - key: listUsers
+      id: list_users
+      url: /reference/user-management/user/list
+      title: userManagement.listUsers()
+      parameters:
+        - key: options
+          type: ListUsersOptions
+          optional: true
+          unwrap: true
+          properties:
+            - key: email
+              optional: true
+              type: String
+              description: (list_users.email)
+            - key: organizationId
+              optional: true
+              type: String
+              description: (list_users.organization_id)
+            - (after)
+            - (before)
+            - (limit)
+            - (order)
+      returns:
+        - key: anonymous
+          type: Users
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[User]'
+              description: (list_users.data)
+            - key: listMetadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/user/list.mdx
+---
+
+## List users
+
+Get a list of all of your existing users matching the criteria specified.
+
+<CodeBlock referenceId="list_users">
+  <CodeBlockTab title="Request" file="list-users-request" />
+  <CodeBlockTab title="Response" file="list-users-response" />
+</CodeBlock>