@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/audit-logs/create-export.mdx

@@ -0,0 +1,308 @@
+---
+descriptions:
+  create_export:
+    organization_id: The unique ID of the Organization.
+    range_start: ISO-8601 value for start of the export range.
+    range_end: ISO-8601 value for end of the export range.
+    actions: List of actions to filter against.
+    actor_names: List of actor names to filter against.
+    actor_ids: List of actor IDs to filter against.
+    targets: List of target types to filter against.
+reference:
+  curl:
+    - key: create_export
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: /audit_logs/exports
+      type: POST
+      parameters:
+        - key: organization_id
+          type: string
+          description: (create_export.organization_id)
+        - key: range_start
+          type: string
+          description: (create_export.range_start)
+        - key: range_end
+          type: string
+          description: (create_export.range_end)
+        - key: actions
+          type: array
+          optional: true
+          description: (create_export.actions)
+        - key: actor_ids
+          type: array
+          optional: true
+          description: (create_export.actor_ids)
+        - key: actor_names
+          type: array
+          optional: true
+          description: (create_export.actor_names)
+        - key: targets
+          type: array
+          optional: true
+          description: (create_export.targets)
+      returns:
+        - (audit_log_export)
+  js:
+    - key: createExport
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: auditLogs.createExport()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (create_export.organization_id)
+            - key: rangeStart
+              type: Date
+              description: (create_export.range_start)
+            - key: rangeEnd
+              type: Date
+              description: (create_export.range_end)
+            - key: actions
+              type: 'string[]'
+              optional: true
+              description: (create_export.actions)
+            - key: actor_ids
+              type: 'string[]'
+              optional: true
+              description: (create_export.actor_ids)
+            - key: actor_names
+              type: 'string[]'
+              optional: true
+              description: (create_export.actor_names)
+            - key: targets
+              type: 'string[]'
+              optional: true
+              description: (create_export.targets)
+      returns:
+        - (AuditLogExport)
+  java:
+    - key: createExport
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: auditLogs.createExport()
+      parameters:
+        - key: options
+          type: CreateExportOptions
+          expanded: true
+          properties:
+            - key: organizationId
+              type: String
+              description: (create_export.organization_id)
+            - key: rangeStart
+              type: Date
+              description: (create_export.range_start)
+            - key: rangeEnd
+              type: Date
+              description: (create_export.range_end)
+            - key: actions
+              type: List<String>
+              optional: true
+              description: (create_export.actions)
+            - key: actor_ids
+              type: List<String>
+              optional: true
+              description: (create_export.actor_ids)
+            - key: actor_names
+              type: List<String>
+              optional: true
+              description: (create_export.actor_names)
+            - key: targets
+              type: List<String>
+              optional: true
+              description: (create_export.targets)
+      returns:
+        - (AuditLogExport)
+  dotnet:
+    - key: CreateExport
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: auditLogsService.CreateExport()
+      parameters:
+        - key: CreateAuditLogExportOptions
+          expanded: true
+          properties:
+            - key: OrganizationId
+              type: string
+              description: (create_export.organization_id)
+            - key: RangeStart
+              type: DateTime
+              description: (create_export.range_start)
+            - key: RangeEnd
+              type: DateTime
+              description: (create_export.range_end)
+            - key: Actions
+              type: List<string>
+              optional: true
+              description: (create_export.actions)
+            - key: ActorIds
+              type: List<string>
+              optional: true
+              description: (create_export.actor_ids)
+            - key: ActorNames
+              type: List<string>
+              optional: true
+              description: (create_export.actor_names)
+            - key: Targets
+              type: List<string>
+              optional: true
+              description: (create_export.targets)
+        - (cancellationToken)
+      returns:
+        - key: Task<AuditLogExport>
+          description: (audit_log_export.self)
+  php:
+    - key: createExport
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: $auditLogs->createExport()
+      parameters:
+        - key: organizationId
+          type: string
+          description: (create_export.organization_id)
+        - key: rangeStart
+          type: string
+          description: (create_export.range_start)
+        - key: rangeEnd
+          type: string
+          description: (create_export.range_end)
+        - key: actions
+          type: 'string[]'
+          optional: true
+          description: (create_export.actions)
+        - key: actor_ids
+          type: 'string[]'
+          optional: true
+          description: (create_export.actor_ids)
+        - key: actor_names
+          type: 'string[]'
+          optional: true
+          description: (create_export.actor_names)
+        - key: targets
+          type: 'string[]'
+          optional: true
+          description: (create_export.targets)
+      returns:
+        - (AuditLogExport)
+  python:
+    - key: create_export
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: audit_logs.create_export()
+      parameters:
+        - key: organization_id
+          type: str
+          description: (create_export.organization_id)
+        - key: range_start
+          type: str
+          description: (create_export.range_start)
+        - key: range_end
+          type: str
+          description: (create_export.range_end)
+        - key: actions
+          type: 'Sequence[str]'
+          optional: true
+          description: (create_export.actions)
+        - key: actor_ids
+          type: 'Sequence[str]'
+          optional: true
+          description: (create_export.actor_ids)
+        - key: actor_names
+          type: 'Sequence[str]'
+          optional: true
+          description: (create_export.actor_names)
+        - key: targets
+          type: 'Sequence[str]'
+          optional: true
+          description: (create_export.targets)
+      returns:
+        - (AuditLogExport)
+  ruby:
+    - key: create_export
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: AuditLogs.create_export()
+      parameters:
+        - key: organization_id
+          type: String
+          description: (create_export.organization_id)
+        - key: range_start
+          type: String
+          description: (create_export.range_start)
+        - key: range_end
+          type: String
+          description: (create_export.range_end)
+        - key: actions
+          type: 'Array[String]'
+          optional: true
+          description: (create_export.actions)
+        - key: actor_ids
+          type: 'Array[String]'
+          optional: true
+          description: (create_export.actor_ids)
+        - key: actor_names
+          type: 'Array[String]'
+          optional: true
+          description: (create_export.actor_names)
+        - key: targets
+          type: 'Array[String]'
+          optional: true
+          description: (create_export.targets)
+      returns:
+        - (AuditLogExport)
+  go:
+    - key: CreateExport
+      id: create_export
+      url: /reference/audit-logs/create-export
+      title: auditlogs.CreateExport()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: auditlogs.CreateExportOpts
+          expanded: true
+          properties:
+            - key: OrganizationID
+              type: string
+              description: (create_export.organization_id)
+            - key: RangeStart
+              type: time.Time
+              description: (create_export.range_start)
+            - key: RangeEnd
+              type: time.Time
+              description: (create_export.range_end)
+            - key: Actions
+              type: '[]string'
+              optional: true
+              description: (create_export.actions)
+            - key: ActorIds
+              type: '[]string'
+              optional: true
+              description: (create_export.actor_ids)
+            - key: ActorNames
+              type: '[]string'
+              optional: true
+              description: (create_export.actor_names)
+            - key: Targets
+              type: '[]string'
+              optional: true
+              description: (create_export.targets)
+      returns:
+        - key: export
+          type: auditlogs.AuditLogExport
+          description: (audit_log_export.self)
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/create-export.mdx
+---
+
+## Create Export
+
+Create an Audit Log Export.
+
+<CodeBlock referenceId="create_export">
+  <CodeBlockTab title="Request" file="create-export-request" />
+  <CodeBlockTab title="Response" file="create-export-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/audit-logs/create-schema.mdx

@@ -0,0 +1,95 @@
+---
+descriptions:
+  create_schema:
+    action: Identifier of what happened
+    actor:
+      metadata: JSON schema for actor `metadata`
+    targets:
+      type: Actor type
+      metadata: Optional JSON schema for target `metadata`
+      return: The list of targets for this schema
+    metadata: Optional JSON schema for event `metadata`
+    version: The schema version
+reference:
+  curl:
+    - key: create_schema
+      id: create_schema
+      url: /reference/audit-logs/create-schema
+      title: '/audit_logs/actions/:name/schemas'
+      type: POST
+      parameters:
+        - key: actor
+          type: object
+          optional: true
+          expanded: true
+          properties:
+            - key: metadata
+              type: object
+              description: (create_schema.actor.metadata)
+        - key: targets
+          type: array
+          expanded: true
+          properties:
+            - key: type
+              type: string
+              description: (create_schema.targets.type)
+            - key: metadata
+              type: object
+              optional: true
+              description: (create_schema.targets.metadata)
+        - key: metadata
+          type: object
+          optional: true
+          description: (create_schema.metadata)
+      returns:
+        - (audit_log_schema)
+  js:
+    - key: createSchema
+      id: create_schema
+      url: /reference/audit-logs/create-schema
+      title: auditLogs.createSchema()
+      parameters:
+        - key: schema
+          type: object
+          expanded: true
+          properties:
+            - key: action
+              type: string
+              description: (create_schema.action)
+            - key: actor
+              type: object
+              expanded: true
+              optional: true
+              properties:
+                - key: metadata
+                  type: object
+                  description: (create_schema.actor.metadata)
+            - key: targets
+              type: array
+              expanded: true
+              properties:
+                - key: type
+                  type: string
+                  description: (create_schema.targets.type)
+                - key: metadata
+                  type: object
+                  optional: true
+                  description: (create_schema.targets.metadata)
+            - key: metadata
+              type: object
+              optional: true
+              description: (create_schema.metadata)
+      returns:
+        - (AuditLogSchema)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/create-schema.mdx
+---
+
+## Create Schema
+
+Creates a new Audit Log schema used to validate the payload of incoming Audit Log Events. If the `action` does not exist, it will also be created.
+
+<CodeBlock
+  title="Request"
+  referenceId="create_schema"
+  file="create-schema-request"
+/>

package/.docs/organized/docs/reference/audit-logs/get-export.mdx

@@ -0,0 +1,117 @@
+---
+descriptions:
+  get_export:
+    id: The unique ID of the Audit Log Export.
+reference:
+  curl:
+    - key: get_export
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: '/audit_logs/exports/:id'
+      type: GET
+      parameters:
+        - key: id
+          type: string
+          description: (get_export.id)
+      returns:
+        - (audit_log_export)
+  js:
+    - key: getExport
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: auditLogs.getExport()
+      parameters:
+        - key: id
+          type: string
+          description: (get_export.id)
+      returns:
+        - (AuditLogExport)
+  java:
+    - key: getExport
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: auditLogs.getExport()
+      parameters:
+        - key: id
+          type: String
+          description: (get_export.id)
+      returns:
+        - (AuditLogExport)
+  dotnet:
+    - key: GetExport
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: auditLogsService.GetExport()
+      parameters:
+        - key: Id
+          type: string
+          description: (get_export.id)
+        - (cancellationToken)
+      returns:
+        - key: Task<AuditLogExport>
+          description: (audit_log_export.self)
+  php:
+    - key: getExport
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: $auditLogs->getExport()
+      parameters:
+        - key: id
+          type: string
+          description: (get_export.id)
+      returns:
+        - (AuditLogExport)
+  python:
+    - key: get_export
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: audit_logs.get_export()
+      parameters:
+        - key: audit_log_export_id
+          type: str
+          description: (get_export.id)
+      returns:
+        - (AuditLogExport)
+  ruby:
+    - key: get_export
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: AuditLogs.get_export()
+      parameters:
+        - key: id
+          type: String
+          description: (get_export.id)
+      returns:
+        - (AuditLogExport)
+  go:
+    - key: GetExport
+      id: get_export
+      url: /reference/audit-logs/get-export
+      title: auditlogs.GetExport()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: auditlogs.GetExportOpts
+          expanded: true
+          properties:
+            - key: ExportID
+              type: string
+              description: (get_export.id)
+      returns:
+        - key: export
+          type: auditlogs.AuditLogExport
+          description: (audit_log_export.self)
+        - (err)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/get-export.mdx
+---
+
+## Get Export
+
+Get an Audit Log Export.
+
+<CodeBlock referenceId="get_export">
+  <CodeBlockTab title="Request" file="get-export-request" />
+  <CodeBlockTab title="Response" file="get-export-response" />
+</CodeBlock>
+
+> The URL will expire after 10 minutes. If the export is needed again at a later time, refetching the export will regenerate the URL.

package/.docs/organized/docs/reference/audit-logs/get-retention.mdx

@@ -0,0 +1,34 @@
+---
+descriptions:
+  get_retention:
+    retention_period_in_days: The number of days Audit Log events will be retained.
+reference:
+  curl:
+    - key: get_retention
+      id: get_retention
+      url: /reference/audit-logs/get-retention
+      title: '/organizations/:id/audit_logs_retention'
+      type: GET
+      parameters:
+        - key: id
+          type: string
+          description: (organization.id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: retention_period_in_days
+              type: number
+              description: (get_retention.retention_period_in_days)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/get-retention.mdx
+---
+
+## Get Retention
+
+Get the configured event retention period for the given Organization.
+
+<CodeBlock referenceId="get_retention">
+  <CodeBlockTab title="Request" file="get-retention-request" />
+  <CodeBlockTab title="Response" file="get-retention-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/audit-logs/index.mdx

@@ -0,0 +1,6 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/index.mdx
+---
+# Audit Logs
+
+Audit Logs are a collection of events that contain information relevant to notable actions taken by users in your application. Every event in the collection contains details regarding what kind of action was taken (`action`), who performed the action (`actor`), what resources were affected by the action (`targets`), and additional details of when and where the action took place.

package/.docs/organized/docs/reference/audit-logs/list-actions.mdx

@@ -0,0 +1,40 @@
+---
+descriptions:
+  list_actions:
+    data: Array of Audit Log actions.
+reference:
+  curl:
+    - key: list_actions
+      id: list_actions
+      url: /reference/audit-logs/list-actions
+      title: /audit_logs/actions
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_actions.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/list-actions.mdx
+---
+
+## List Actions
+
+Get a list of all Audit Log actions in the current environment.
+
+<CodeBlock referenceId="list_actions">
+  <CodeBlockTab title="Request" file="list-actions-request" />
+  <CodeBlockTab title="Response" file="list-actions-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/audit-logs/list-schemas.mdx

@@ -0,0 +1,40 @@
+---
+descriptions:
+  list_schemas:
+    data: Array of Audit Log schemas.
+reference:
+  curl:
+    - key: list_schemas
+      id: list_schemas
+      url: /reference/audit-logs/list-schemas
+      title: '/audit_logs/actions/:name/schemas'
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_schemas.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/list-schemas.mdx
+---
+
+## List Schemas
+
+Get a list of all schemas for the Audit Logs action identified by `:name`.
+
+<CodeBlock referenceId="list_schemas">
+  <CodeBlockTab title="Request" file="list-schemas-request" />
+  <CodeBlockTab title="Response" file="list-schemas-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/audit-logs/set-retention.mdx

@@ -0,0 +1,39 @@
+---
+descriptions:
+  set_retention:
+    retention_period_in_days: >-
+      The number of days Audit Log events will be retained. Valid values are
+      `30` and `365`.
+reference:
+  curl:
+    - key: set_retention
+      id: set_retention
+      url: /reference/audit-logs/set-retention
+      title: '/organizations/:id/audit_logs_retention'
+      type: PUT
+      parameters:
+        - key: id
+          type: string
+          description: (organization.id)
+        - key: retention_period_in_days
+          type: number
+          description: (set_retention.retention_period_in_days)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: retention_period_in_days
+              type: number
+              description: (get_retention.retention_period_in_days)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/set-retention.mdx
+---
+
+## Set Retention
+
+Set the event retention period for the given Organization.
+
+<CodeBlock referenceId="set_retention">
+  <CodeBlockTab title="Request" file="set-retention-request" />
+  <CodeBlockTab title="Response" file="set-retention-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/client-libraries.mdx

@@ -0,0 +1,19 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/client-libraries.mdx
+---
+# Client libraries
+
+WorkOS offers native SDKs in several popular programming languages. Choose one language below to see our API Reference in your application’s language.
+
+<LanguageSelector>
+  Install the SDK using the command below.
+
+  <CodeBlock title="Install the WorkOS SDK" file="install-sdk">
+    <CodeBlockTab language="js" file="install-sdk-npm" title="npm" />
+    <CodeBlockTab language="js" file="install-sdk-yarn" title="Yarn" />
+    <CodeBlockTab language="java" file="install-sdk-maven" title="Maven" />
+    <CodeBlockTab language="java" file="install-sdk-gradle" title="Gradle" />
+    <CodeBlockTab language="ruby" file="install-sdk-terminal" title="Terminal" />
+    <CodeBlockTab language="ruby" file="install-sdk-bundler" title="Bundler" />
+  </CodeBlock>
+</LanguageSelector>