@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx

@@ -0,0 +1,304 @@
+---
+descriptions:
+  directory_user_directory: |
+    Unique identifier of the WorkOS Directory.
+
+    This value can be obtained from the WorkOS dashboard or from the WorkOS API.
+  directory_user_group: |
+    Unique identifier of the WorkOS Directory Group.
+
+    This value can be obtained from the WorkOS API.
+  directory_user_list: >
+    Array of [Directory Users](/reference/directory-sync/directory-user) ordered
+    by creation time.
+
+
+    Since these can be bulk processed (ex. 10 updates were batched process),
+    there is a secondary sort on the identifier, i.e. `id`.
+reference:
+  curl:
+    - key: list_directories_user
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: /directory_user
+      type: GET
+      parameters:
+        - key: directory
+          optional: true
+          type: string
+          description: (directory_user_directory)
+        - key: group
+          optional: true
+          type: string
+          description: (directory_user_group)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (directory_user_list)
+            - key: list_metadata
+              type: object
+              properties:
+                - (after)
+                - (before)
+  dotnet:
+    - key: ListDirectoryUsers
+      patternBefore: directorySyncService.
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: directorySyncService.ListDirectoryUsers()
+      parameters:
+        - key: options
+          type: ListDirectoryUsersOptions
+          expanded: true
+          properties:
+            - key: Directory
+              optional: true
+              type: string
+              description: (directory_user_directory)
+            - key: Group
+              optional: true
+              type: string
+              description: (directory_user_group)
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+        - (cancellationToken)
+      returns:
+        - key: Task<WorkOSList<DirectoryUser>>
+          expanded: true
+          properties:
+            - key: Data
+              type: List<DirectoryUser>
+              description: (directory_list)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (Before)
+                - (After)
+  ruby:
+    - key: list_users
+      patternBefore: DirectorySync.
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: DirectorySync.list_users()
+      parameters:
+        - key: directory
+          optional: true
+          type: String
+          description: (directory_user_directory)
+        - key: group
+          optional: true
+          type: String
+          description: (directory_user_group)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[DirectoryUser]'
+              description: (directory_user_list)
+            - key: list_metadata
+              type: Hash
+              properties:
+                - (after)
+                - (before)
+  python:
+    - key: list_users
+      patternBefore: directory_sync.
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: directory_sync.list_users()
+      parameters:
+        - key: directory_id
+          optional: true
+          type: str
+          description: (directory_user_directory)
+        - key: group_id
+          optional: true
+          type: str
+          description: (directory_user_group)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[DirectoryUser]'
+              description: (directory_user_list)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (after)
+                - (before)
+  js:
+    - key: listUsers
+      patternBefore: directorySync.
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: directorySync.listUsers()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: directory
+              optional: true
+              type: string
+              description: (directory_user_directory)
+            - key: group
+              optional: true
+              type: string
+              description: (directory_user_group)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'DirectoryUser[]'
+              description: (directory_user_list)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  java:
+    - key: listDirectoryUsers
+      patternBefore: directorySync.
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: directorySync.listDirectoryUsers()
+      parameters:
+        - key: options
+          type: ListDirectoryUserOptions
+          expanded: true
+          properties:
+            - key: directory
+              optional: true
+              type: String
+              description: (directory_user_directory)
+            - key: group
+              optional: true
+              type: String
+              description: (directory_user_group)
+            - (after)
+            - (order)
+            - (limit)
+            - (before)
+            - key: builder()
+              type: ListDirectoryUserOptionsBuilder
+              description: (java.builder)
+      returns:
+        - key: directoryUserList
+          type: DirectoryUserList
+          expanded: true
+          properties:
+            - key: data
+              type: List<User>
+              description: (directory_user_list)
+            - key: listMetadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+  php:
+    - key: listUsers
+      patternBefore: ds->
+      id: list_directory_users
+      url: /reference/directory-sync/directory-user/list
+      title: $ds->listUsers()
+      parameters:
+        - key: directory
+          optional: true
+          type: string
+          description: (directory_user_directory)
+        - key: group
+          optional: true
+          type: string
+          description: (directory_user_group)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - (before)
+            - (after)
+            - key: data
+              type: 'DirectoryUser[]'
+              description: (directory_user_list)
+  go:
+    - key: ListUsers
+      patternBefore: directorysync.
+      id: list_directory_users
+      url: /reference/directory-sync/directory/list
+      title: directorysync.ListUsers()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: directorysync.ListUsersOpts
+          expanded: true
+          properties:
+            - key: Directory
+              optional: true
+              type: string
+              description: (directory_user_directory)
+            - key: Group
+              optional: true
+              type: string
+              description: (directory_user_group)
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+      returns:
+        - key: list
+          type: directorysync.ListUsersResponse
+          expanded: true
+          properties:
+            - key: Data
+              type: '[]directorysync.User'
+              description: (directory_list)
+            - key: ListMetadata
+              type: common.ListMetadata
+              properties:
+                - (Before)
+                - (After)
+        - (err)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory-user/list.mdx
+---
+
+## List Directory Users
+
+Get a list of all of existing Directory Users matching the criteria specified.
+
+<CodeBlock referenceId="list_directory_users">
+  <CodeBlockTab title="Request" file="list-directory-user-request" />
+  <CodeBlockTab title="Response" file="list-directory-user-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/directory-sync/index.mdx

@@ -0,0 +1,10 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/directory-sync/index.mdx
+---
+# Directory Sync
+
+Directory Sync allows you to connect with directory providers to inform your application of any changes in their users, groups, or access rules.
+
+Using Directory Sync, one integration grants your application the ability to support multiple directory providers. Get real-time updates of any changes to the organization's access rules, groups, and users by integrating webhooks into your application.
+
+To automatically respond to changes in the connected directories and their users and groups, use the [Directory Sync events](/events/directory-sync).

package/.docs/organized/docs/reference/domain-verification/create.mdx

@@ -0,0 +1,38 @@
+---
+reference:
+  curl:
+    - key: create_organization_domain
+      type: POST
+      id: create_organization_domain
+      url: /reference/domain-verification/create
+      title: /organization-domains
+      parameters:
+        - (organization_domain.organization_id)
+        - (organization_domain.domain)
+      returns:
+        - (organization_domain)
+  js:
+    - key: createOrganizationDomain
+      id: create_organization_domain
+      url: /reference/domain-verification/create
+      title: organizationDomains.create()
+      parameters:
+        - key: options
+          unwrap: true
+          properties:
+            - (OrganizationDomain.organizationId)
+            - (OrganizationDomain.domain)
+      returns:
+        - (OrganizationDomain)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/domain-verification/create.mdx
+---
+
+## Create an Organization Domain
+
+Creates a new Organization Domain.
+
+<CodeBlock referenceId="create_organization_domain">
+  <CodeBlockTab title="Request" file="create-organization-domain-request" />
+  <CodeBlockTab title="Response" file="create-organization-domain-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/domain-verification/get.mdx

@@ -0,0 +1,32 @@
+---
+reference:
+  curl:
+    - key: get_organization_domain
+      id: get_organization_domain
+      url: /reference/domain-verification/get
+      title: '/organization_domains/:id'
+      type: GET
+      parameters:
+        - (organization_domain.id)
+      returns:
+        - (organization_domain)
+  js:
+    - key: getOrganizationDomain
+      id: get_organization_domain
+      url: /reference/domain-verification/get
+      title: organizationDomains.get()
+      parameters:
+        - (Organization.id)
+      returns:
+        - (OrganizationDomain)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/domain-verification/get.mdx
+---
+
+## Get an Organization Domain
+
+Get the details of an existing organization.
+
+<CodeBlock referenceId="get_organization_domain">
+  <CodeBlockTab title="Request" file="get-organization-domain-request" />
+  <CodeBlockTab title="Response" file="get-organization-domain-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/domain-verification/index.mdx

@@ -0,0 +1,84 @@
+---
+descriptions:
+  organization_domain:
+    self: 'The [organization domain](/reference/domain-verification) object.'
+    object: Distinguishes the organization domain object.
+    id: Unique identifier of the organization domain.
+    organization_id: ID of the parent Organization.
+    state: Verification state of the domain.
+    domain: Domain for the organization domain.
+    verification_strategy: Strategy used to verify the domain
+    verification_token: validation token to be used in DNS TXT record.
+reference:
+  curl:
+    - url: /reference/domain-verification
+      key: organization_domain
+      id: organization-domain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (organization_domain.object)
+        - key: id
+          type: string
+          description: (organization_domain.id)
+        - key: organization_id
+          type: string
+          description: (organization_domain.organization_id)
+        - key: domain
+          type: string
+          description: (organization_domain.domain)
+        - key: state
+          type: |
+            "pending" | "verified" | "failed"
+          description: (organization_domain.state)
+        - key: verificationStrategy
+          type: |
+            "dns" | "manual"
+          description: (organization_domain.verification_strategy)
+        - key: verificationToken
+          type: string
+          description: (organization_domain.verification_token)
+  js:
+    - url: /reference/domain-verification
+      key: OrganizationDomain
+      title: interface OrganizationDomain
+      id: organization-domain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (organization_domain.object)
+        - key: id
+          type: string
+          description: (organization_domain.id)
+        - key: organizationId
+          type: string
+          description: (organization_domain.organization_id)
+        - key: domain
+          type: string
+          description: (organization_domain.domain)
+        - key: state
+          type: |
+            "pending" | "verified" | "failed"
+          description: (organization_domain.state)
+        - key: verificationStrategy
+          type: |
+            "dns" | "manual"
+          description: (organization_domain.verification_strategy)
+        - key: verificationToken
+          type: string
+          description: (organization_domain.verification_token)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/domain-verification/index.mdx
+---
+
+# Organization domain
+
+An organization domain represents an [organization](/reference/organization)'s domain. Domains can be verified to assert that an organization owns the configured domain which is accomplished through DNS TXT record verification.
+
+To automatically respond to changes in the organization domains, use [Domain Verification events](/events/organization-domain).
+
+<CodeBlock
+  title="Example organization domain"
+  file="organization-domain"
+  referenceId="organization-domain"
+/>

package/.docs/organized/docs/reference/domain-verification/verify.mdx

@@ -0,0 +1,36 @@
+---
+reference:
+  curl:
+    - key: verify_organization_domain
+      type: POST
+      id: verify_organization_domain
+      url: /reference/domain-verification/verify
+      title: '/organization-domains/:id/verify'
+      parameters:
+        - (organization_domain.id)
+      returns:
+        - (organization_domain)
+  js:
+    - key: verifyOrganization
+      id: verify_organization_domain
+      url: /reference/domain-verification/verify
+      title: organizationDomains.verify()
+      parameters:
+        - key: options
+          unwrap: true
+          properties:
+            - (OrganizationDomain.id)
+      returns:
+        - (OrganizationDomain)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/domain-verification/verify.mdx
+---
+
+## Verify an Organization Domain
+
+Initiates verification process for an Organization Domain.
+
+<CodeBlock referenceId="verify_organization_domain">
+  <CodeBlockTab title="Request" file="verify-organization-domain-request" />
+  <CodeBlockTab title="Response" file="verify-organization-domain-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/errors.mdx

@@ -0,0 +1,30 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/errors.mdx
+---
+# Errors
+
+WorkOS uses standard HTTP response codes to indicate the success or failure of your API requests.
+
+200
+: Successful request.
+
+400
+: The request was not acceptable. Check that the parameters were correct.
+
+401
+: The API key used was invalid.
+
+403
+: The API key used did not have the correct permissions.
+
+404
+: The resource was not found.
+
+422
+: Validation failed for the request. Check that the parameters were correct.
+
+429
+: Too many requests. Refer to the [Rate Limits](/reference/rate-limits) section.
+
+5xx
+: Indicates an error with WorkOS servers.

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

@@ -0,0 +1,9 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/events/index.mdx
+---
+# Events
+
+Events represent activity that has occurred within WorkOS or within third-party identity and directory providers. They are used to keep your app in sync with WorkOS data.
+For more details on consuming events in your app, check out the [data syncing](/events/data-syncing) guide.
+
+Refer to the [Events](/events) page for a full list of events that WorkOS emits.