@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx

@@ -6,7 +6,7 @@ originalPath: >-
   .tmp-workos-clone/packages/docs/content/reference/admin-portal/portal-link/index.mdx
 ---
 
-## Portal Link
+# Portal Link
 
 A Portal Link is a temporary endpoint to initiate an Admin Portal session. It expires five minutes after issuance.
 

package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx

@@ -5,11 +5,11 @@ originalPath: >-
   .tmp-workos-clone/packages/docs/content/reference/admin-portal/provider-icons/index.mdx
 ---
 
-## Provider Icons
+# Provider Icons
 
 Icons for third-party providers are available through the WorkOS CDN. These icons cover identity providers, Directory Sync, and domain verification services used within the Admin Portal.
 
-### List Provider Icons
+## List Provider Icons
 
 Get a list of all of existing provider icons.
 
@@ -26,7 +26,7 @@ Get a list of all of existing provider icons.
   figmaURL="https://www.figma.com/community/file/1408148024751538607/provider-icons"
 />
 
-### Get a Provider Icon
+## Get a Provider Icon
 
 To use an icon in your project, you can reference the CDN link directly. You can alternate between light and dark mode icons by changing the path in the URL or using CSS media queries.
 

package/.docs/organized/docs/reference/{api-keys.mdx → api-authentication/index.mdx}

@@ -1,11 +1,11 @@
 ---
-originalPath: .tmp-workos-clone/packages/docs/content/reference/api-keys.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/api-authentication/index.mdx
 ---
-# API Keys
+# API authentication
 
 WorkOS authenticates your API requests using your account’s API keys. API requests made without authentication or using an incorrect key will return a `401` error. Requests using a valid key but with insufficient permissions will return a `403` error. All API requests must be made over HTTPS. Any requests made over plain HTTP will fail.
 
-<CodeBlock title="Set API Key" file="set-api-key" />
+<CodeBlock title="Using an API key" file="set-api-key" />
 
 You can view and manage your API keys in the [WorkOS Dashboard](https://dashboard.workos.com/api-keys).
 

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

@@ -0,0 +1,97 @@
+---
+descriptions:
+  get_audit_log_configuration:
+    organization_id: The ID of the Organization
+    retention_period_in_days: The number of days audit log events are retained
+    state: 'The state of the audit log trail (e.g., "active", "inactive", "disabled")'
+    log_stream: >-
+      Optional object containing the audit log stream configuration. Only
+      present if a stream is configured.
+    log_stream.id: The unique identifier for the audit log stream
+    log_stream.type: >-
+      The type of destination for the audit log stream (e.g., "Datadog",
+      "Splunk", "S3", "GoogleCloudStorage", "GenericHttps")
+    log_stream.state: >-
+      The current state of the audit log stream ("active", "inactive", "error",
+      "invalid")
+    log_stream.last_synced_at: >-
+      ISO-8601 timestamp of when the last event was successfully synced, or null
+      if no events have been synced
+    log_stream.created_at: ISO-8601 timestamp indicating when the audit log stream was created
+reference:
+  curl:
+    - key: get_audit_log_configuration
+      id: get_audit_log_configuration
+      url: /reference/audit-logs/configuration
+      title: '/organizations/:id/audit_log_configuration'
+      type: GET
+      parameters:
+        - key: id
+          type: string
+          description: The organization ID
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: organization_id
+              type: string
+              description: The ID of the Organization
+            - key: retention_period_in_days
+              type: number
+              description: The number of days audit log events are retained
+            - key: state
+              type: string
+              description: >-
+                The state of the audit log trail (e.g., "active", "inactive",
+                "disabled")
+            - key: log_stream
+              type: object
+              optional: true
+              description: >-
+                Optional object containing the audit log stream configuration.
+                Only present if a stream is configured.
+              properties:
+                - key: id
+                  type: string
+                  description: The unique identifier for the audit log stream
+                - key: type
+                  type: string
+                  description: >-
+                    The type of destination for the audit log stream (e.g.,
+                    "Datadog", "Splunk", "S3", "GoogleCloudStorage",
+                    "GenericHttps")
+                - key: state
+                  type: string
+                  description: >-
+                    The current state of the audit log stream ("active",
+                    "inactive", "error", "invalid")
+                - key: last_synced_at
+                  type: string
+                  optional: true
+                  description: >-
+                    ISO-8601 timestamp of when the last event was successfully
+                    synced, or null if no events have been synced
+                - key: created_at
+                  type: string
+                  description: >-
+                    ISO-8601 timestamp indicating when the audit log stream was
+                    created
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/audit-logs/configuration/index.mdx
+---
+
+# Get Audit Log Configuration
+
+The Audit Log Configuration endpoint provides a single view of an organization’s audit logging setup. It includes retention settings (how long audit logs are stored), the audit log state (active, inactive, or disabled), and—if configured—the audit log stream, which sends events to external destinations like Splunk, Datadog, S3, Google Cloud Storage, or a custom HTTPS endpoint.
+
+The log_stream field is optional and only appears if the organization has a stream configured. If no stream is set up, the response includes only the audit log retention and state information.
+
+<CodeBlock referenceId="get_audit_log_configuration">
+  <CodeBlockTab title="Request" file="get-configuration-request" />
+  <CodeBlockTab title="Response" file="get-configuration-response" />
+  <CodeBlockTab
+    title="Response (No Stream)"
+    file="get-configuration-response-no-stream"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/audit-logs/{create-event.mdx → event/create.mdx}

@@ -1,5 +1,6 @@
 ---
 descriptions:
+  idempotency_key: A unique string to prevent duplicate requests.
   create_event:
     organization_id: The unique ID of the Organization.
     action: Identifier of what happened
@@ -338,7 +339,10 @@ reference:
                   type: 'Dictionary<string, string>'
                   optional: true
                   description: (create_event.metadata)
-        - (idempotencyKey)
+        - key: idempotencyKey
+          type: string
+          optional: true
+          description: (idempotency_key)
         - (cancellationToken)
   php:
     - key: createEvent
@@ -659,13 +663,19 @@ reference:
               description: (idempotency_key)
       returns:
         - (err)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/create-event.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/event/create.mdx
 ---
 
 ## Create Event
 
 Create an Audit Log Event.
 
+This API supports idempotency which guarantees that performing the same operation multiple times will have the same result as if the operation were performed only once. This is handy in situations where you may need to retry a request due to a failure or prevent accidental duplicate requests from creating more than one resource.
+
+To achieve idempotency, you can add `Idempotency-Key` request header to a Create Event request with a unique string as the value. Each subsequent request matching this unique string will return the same response. We suggest using [v4 UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) for idempotency keys to avoid collisions.
+
+Idempotency keys expire after 24 hours. The API will generate a new response if you submit a request with an expired key.
+
 <CodeBlock
   title="Request"
   referenceId="create_event"

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

@@ -0,0 +1,92 @@
+---
+descriptions:
+  audit_log_event:
+    action: Identifier of what action was taken.
+    occurred_at: ISO-8601 timestamp of when the action occurred.
+    version: The schema version the event is associated with.
+    actor: The entity that performed the action.
+    actor_type: 'The type of the actor (e.g., "user", "system").'
+    actor_id: The unique identifier of the actor.
+    actor_name: An optional display name for the actor.
+    targets: The resources affected by the action.
+    target_type: The type of the target resource.
+    target_id: The unique identifier of the target.
+    target_name: An optional display name for the target.
+    context: Additional context about where and how the action occurred.
+    context_location: IP address or geolocation identifier.
+    context_user_agent: The user agent string of the client.
+    metadata: |
+      Additional data associated with the event or entity.
+      Limited to 50 keys. Key names can be up to 40 characters long,
+      and values can be up to 500 characters long.
+reference:
+  curl:
+    - url: /reference/audit-logs/event
+      key: event
+      id: audit_log_event
+      title: event
+      properties:
+        - key: action
+          type: string
+          description: (audit_log_event.action)
+        - key: occurred_at
+          type: string
+          description: (audit_log_event.occurred_at)
+        - key: version
+          type: number
+          optional: true
+          description: (audit_log_event.version)
+        - key: actor
+          type: object
+          properties:
+            - key: type
+              type: string
+              description: (audit_log_event.actor_type)
+            - key: id
+              type: string
+              description: (audit_log_event.actor_id)
+            - key: name
+              type: string
+              optional: true
+              description: (audit_log_event.actor_name)
+            - key: metadata
+              type: object
+              optional: true
+              description: (audit_log_event.metadata)
+        - key: targets
+          type: array
+          properties:
+            - key: type
+              type: string
+              description: (audit_log_event.target_type)
+            - key: id
+              type: string
+              description: (audit_log_event.target_id)
+            - key: name
+              type: string
+              optional: true
+              description: (audit_log_event.target_name)
+            - key: metadata
+              type: object
+              optional: true
+              description: (audit_log_event.metadata)
+        - key: context
+          type: object
+          properties:
+            - key: location
+              type: string
+              description: (audit_log_event.context_location)
+            - key: user_agent
+              type: string
+              optional: true
+              description: (audit_log_event.context_user_agent)
+        - key: metadata
+          type: object
+          optional: true
+          description: (audit_log_event.metadata)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/event/index.mdx
+---
+
+# Audit Log Event
+
+An Audit Log Event represents a notable action taken within your application. Each event captures what happened, who did it, what was affected, and contextual information about when and where it occurred.

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

@@ -295,7 +295,7 @@ reference:
           type: auditlogs.AuditLogExport
           description: (audit_log_export.self)
         - (err)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/create-export.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/export/create.mdx
 ---
 
 ## Create Export

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

@@ -102,7 +102,7 @@ reference:
           type: auditlogs.AuditLogExport
           description: (audit_log_export.self)
         - (err)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/get-export.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/export/get.mdx
 ---
 
 ## Get Export

package/.docs/organized/docs/reference/audit-logs/{audit-log-export.mdx → export/index.mdx}

@@ -1,7 +1,7 @@
 ---
 descriptions:
   audit_log_export:
-    self: 'The [Audit Log Export](/reference/audit-logs/audit-log-export) object.'
+    self: 'The [Audit Log Export](/reference/audit-logs/export) object.'
     object: Distinguishes the Audit Log Export object.
     id: The unique ID of the Audit Log Export.
     created_at: The timestamp when the Audit Log Export was created.
@@ -20,7 +20,7 @@ descriptions:
     url: A URL to the CSV file. Only defined when the Audit Log Export is ready.
 reference:
   curl:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: audit_log_export
       id: audit_log_export
       title: audit_log_export
@@ -46,7 +46,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   js:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: interface AuditLogExport
@@ -72,7 +72,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   java:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: class AuditLogExport
@@ -97,7 +97,7 @@ reference:
           type: Date
           description: (audit_log_export.updated_at)
   dotnet:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: class AuditLogExport
@@ -122,7 +122,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   php:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: WorkOS\Resource\AuditLogExport
@@ -148,7 +148,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   python:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: AuditLogExport
@@ -174,7 +174,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   ruby:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: class AuditLogExport
@@ -200,7 +200,7 @@ reference:
           optional: true
           description: (audit_log_export.url)
   go:
-    - url: /reference/audit-logs/audit-log-export
+    - url: /reference/audit-logs/export
       key: AuditLogExport
       id: audit_log_export
       title: auditlogs.AuditLogExport
@@ -224,11 +224,10 @@ reference:
           type: string
           optional: true
           description: (audit_log_export.url)
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/audit-logs/audit-log-export.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/export/index.mdx
 ---
 
-## Audit Log Export
+# Audit Log Export
 
 An object representing an Audit Log Export.
 

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

@@ -21,7 +21,7 @@ reference:
             - 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
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/retention/get.mdx
 ---
 
 ## Get Retention

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

@@ -0,0 +1,25 @@
+---
+descriptions:
+  audit_log_retention:
+    retention_period_in_days: >
+      The number of days Audit Log events will be retained before being
+      permanently deleted.
+
+      Valid values are `30` and `365`.
+reference:
+  curl:
+    - url: /reference/audit-logs/retention
+      key: retention
+      id: audit_log_retention
+      title: retention
+      properties:
+        - key: retention_period_in_days
+          type: number
+          description: (audit_log_retention.retention_period_in_days)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/audit-logs/retention/index.mdx
+---
+
+# Audit Log Retention
+
+Retention settings control how long Audit Log events are stored before being permanently deleted. You can configure the retention period on a per-organization basis.

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

@@ -26,7 +26,7 @@ reference:
             - 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
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/retention/set.mdx
 ---
 
 ## Set Retention

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

@@ -81,7 +81,7 @@ reference:
               description: (create_schema.metadata)
       returns:
         - (AuditLogSchema)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/create-schema.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/schema/create.mdx
 ---
 
 ## Create Schema

package/.docs/organized/docs/reference/audit-logs/{audit-log-schema.mdx → schema/index.mdx}

@@ -1,7 +1,7 @@
 ---
 descriptions:
   audit_log_schema:
-    self: 'The [Audit Log Schema](/reference/audit-logs/audit-log-schema) object.'
+    self: 'The [Audit Log Schema](/reference/audit-logs/schema) object.'
     object: Distinguishes the Audit Log Schema object.
     version: The version of the schema.
     targets: The list of targets for the schema.
@@ -13,7 +13,7 @@ descriptions:
     created_at: The timestamp when the Audit Log Schema was created.
 reference:
   curl:
-    - url: /reference/audit-logs/audit-log-schema
+    - url: /reference/audit-logs/schema
       key: audit_log_schema
       id: audit_log_schema
       title: audit_log_schema
@@ -34,7 +34,7 @@ reference:
           type: object
           description: (audit_log_schema.metadata)
   js:
-    - url: /reference/audit-logs/audit-log-schema
+    - url: /reference/audit-logs/schema
       key: AuditLogSchema
       id: audit_log_schema
       title: interface AuditLogSchema
@@ -54,11 +54,10 @@ reference:
         - key: metadata
           type: object
           description: (audit_log_schema.metadata)
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/audit-logs/audit-log-schema.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/schema/index.mdx
 ---
 
-## Audit Log Schema
+# Audit Log Schema
 
 An object representing an Audit Log Schema.
 

package/.docs/organized/docs/reference/audit-logs/{list-actions.mdx → schema/list-actions.mdx}

@@ -27,7 +27,8 @@ reference:
               properties:
                 - (before)
                 - (after)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/list-actions.mdx
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/audit-logs/schema/list-actions.mdx
 ---
 
 ## List Actions

package/.docs/organized/docs/reference/audit-logs/{list-schemas.mdx → schema/list.mdx}

@@ -27,7 +27,7 @@ reference:
               properties:
                 - (before)
                 - (after)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/list-schemas.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/audit-logs/schema/list.mdx
 ---
 
 ## List Schemas

package/.docs/organized/docs/reference/authkit/api-keys/create-for-organization.mdx

@@ -0,0 +1,40 @@
+---
+descriptions:
+  create_organization_api_key:
+    organization_id: The ID of the organization to create the API key for.
+    name: A human-readable name for the API key.
+    permissions: An optional array of permission strings to assign to the API key.
+reference:
+  curl:
+    - key: create_organization_api_key
+      id: create_organization_api_key
+      url: /reference/authkit/api-keys/create-for-organization
+      title: '/organizations/:id/api_keys'
+      type: POST
+      parameters:
+        - key: organization_id
+          type: string
+          description: (create_organization_api_key.organization_id)
+        - key: name
+          type: string
+          description: (create_organization_api_key.name)
+        - key: permissions
+          type: array
+          optional: true
+          description: (create_organization_api_key.permissions)
+      returns:
+        - (api_key)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/authkit/api-keys/create-for-organization.mdx
+---
+
+## Create organization API key
+
+Creates a new API key for the specified organization. The response includes the full API key value, which is only returned once at creation time. Make sure to store this value securely as it cannot be retrieved again.
+
+You can optionally specify permissions to control what actions the API key can perform. If no permissions are provided, the key will have no specific permissions assigned.
+
+<CodeBlock referenceId="create_organization_api_key">
+  <CodeBlockTab title="Request" file="create-organization-api-key" />
+  <CodeBlockTab title="Response" file="create-organization-api-key-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/authkit/api-keys/delete.mdx

@@ -0,0 +1,23 @@
+---
+descriptions:
+  delete_api_key:
+    id: The ID of the API key to delete.
+reference:
+  curl:
+    - key: delete_api_key
+      id: delete_api_key
+      url: /reference/authkit/api-keys/delete
+      title: '/api_keys/:id'
+      type: DELETE
+      parameters:
+        - (api_key.id)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/api-keys/delete.mdx
+---
+
+## Delete API key
+
+Permanently deletes an API key. This action cannot be undone. Once deleted, any requests using this API key will fail authentication.
+
+<CodeBlock referenceId="delete_api_key">
+  <CodeBlockTab title="Request" file="delete-api-key" />
+</CodeBlock>