@workos/mcp-docs-server 0.1.0

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

@@ -0,0 +1,268 @@
+---
+descriptions:
+  generate_portal_link:
+    organization: 'An [Organization](/reference/organization) identifier.'
+    intent:
+      lowercase: |
+        The intent of the Admin Portal.
+          - `sso` - Launch Admin Portal for creating SSO connections
+          - `dsync` - Launch Admin Portal for creating Directory Sync connections
+          - `audit_logs` - Launch Admin Portal for viewing Audit Logs
+          - `log_streams` - Launch Admin Portal for creating Log Streams
+          - `domain_verification` - Launch Admin Portal for Domain Verification
+          - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
+      titlecase: |
+        The intent of the Admin Portal.
+          - `SSO` - Launch Admin Portal for creating SSO connections
+          - `DSync` - Launch Admin Portal for creating Directory Sync connections
+          - `AuditLogs` - Launch Admin Portal for viewing Audit Logs
+          - `LogStreams` - Launch Admin Portal for creating Log Streams
+          - `DomainVerification` - Launch Admin Portal for Domain Verification
+          - `CertificateRenewal` - Launch Admin Portal for renewing SAML Certificates
+    return_url: >-
+      The URL to go to when an admin clicks on your logo in the Admin Portal. If
+      not specified, the return URL configured on the
+      [Redirects](https://dashboard.workos.com/redirects) page will be used.
+    success_url: >-
+      The URL to redirect the admin to when they finish setup. If not specified,
+      the success URL configured on the
+      [Redirects](https://dashboard.workos.com/redirects) page will be used.
+reference:
+  curl:
+    - key: generate_portal_link
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: /portal/generate_link
+      type: POST
+      parameters:
+        - key: organization
+          type: string
+          description: (generate_portal_link.organization)
+        - key: intent
+          type: enum
+          description: (generate_portal_link.intent.lowercase)
+        - key: return_url
+          optional: true
+          type: string
+          description: (generate_portal_link.return_url)
+        - key: success_url
+          optional: true
+          type: string
+          description: (generate_portal_link.success_url)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: link
+              type: string
+              description: (portal_link.link)
+  dotnet:
+    - key: GenerateLink
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: portalService.GenerateLink()
+      parameters:
+        - key: options
+          type: GenerateLinkOptions
+          expanded: true
+          properties:
+            - key: Organization
+              type: string
+              description: (generate_portal_link.organization)
+            - key: Intent
+              type: Intent
+              description: (generate_portal_link.intent.titlecase)
+            - key: ReturnURL
+              optional: true
+              type: string
+              description: (generate_portal_link.return_url)
+            - key: SuccessURL
+              optional: true
+              type: string
+              description: (generate_portal_link.success_url)
+        - (cancellationToken)
+      returns:
+        - key: Task<string>
+          description: (portal_link.link)
+  ruby:
+    - key: generate_link
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: Portal.generate_link()
+      parameters:
+        - key: organization
+          type: String
+          description: (generate_portal_link.organization)
+        - key: intent
+          type: String
+          description: (generate_portal_link.intent.lowercase)
+        - key: return_url
+          optional: true
+          type: String
+          description: (generate_portal_link.return_url)
+        - key: success_url
+          optional: true
+          type: String
+          description: (generate_portal_link.success_url)
+      returns:
+        - key: link
+          type: String
+          description: (portal_link.link)
+  js:
+    - key: generateLink
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: portal.generateLink()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organization
+              type: string
+              description: (generate_portal_link.organization)
+            - key: intent
+              type: string
+              description: (generate_portal_link.intent.lowercase)
+            - key: returnUrl
+              optional: true
+              type: string
+              description: (generate_portal_link.return_url)
+            - key: successUrl
+              optional: true
+              type: string
+              description: (generate_portal_link.success_url)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: link
+              type: string
+              description: (portal_link.link)
+  python:
+    - key: generate_link
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: portal.generate_link()
+      parameters:
+        - key: organization
+          type: str
+          description: (generate_portal_link.organization)
+        - key: intent
+          type: PortalLinkIntent
+          description: (generate_portal_link.intent.lowercase)
+        - key: return_url
+          optional: true
+          type: str
+          description: (generate_portal_link.return_url)
+        - key: success_url
+          optional: true
+          type: str
+          description: (generate_portal_link.success_url)
+      returns:
+        - key: link
+          type: str
+          description: (portal_link.link)
+  go:
+    - key: GenerateLink
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: portal.GenerateLink()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: portal.GenerateLinkOpts
+          expanded: true
+          properties:
+            - key: Organization
+              type: string
+              description: (generate_portal_link.organization)
+            - key: Intent
+              type: portal.GenerateLinkIntent
+              description: (generate_portal_link.intent.titlecase)
+            - key: ReturnURL
+              optional: true
+              type: string
+              description: (generate_portal_link.return_url)
+            - key: SuccessURL
+              optional: true
+              type: string
+              description: (generate_portal_link.success_url)
+      returns:
+        - key: link
+          type: string
+          description: (portal_link.link)
+        - (err)
+  php:
+    - key: generateLink
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: $portal->generateLink()
+      parameters:
+        - key: organization
+          type: string
+          description: (generate_portal_link.organization)
+        - key: intent
+          type: string
+          description: (generate_portal_link.intent.lowercase)
+        - key: return_url
+          optional: true
+          type: string
+          description: (generate_portal_link.return_url)
+        - key: success_url
+          optional: true
+          type: string
+          description: (generate_portal_link.success_url)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - key: link
+              type: string
+              description: (portal_link.link)
+  java:
+    - key: generate_portal_link
+      id: generate_portal_link
+      url: /reference/admin-portal/portal-link/generate
+      title: portal.generateLink()
+      parameters:
+        - key: options
+          type: GeneratePortalLinkOptions
+          expanded: true
+          properties:
+            - key: organization
+              type: String
+              description: (generate_portal_link.organization)
+            - key: intent
+              type: Intent
+              description: (generate_portal_link.intent.lowercase)
+            - key: returnUrl
+              optional: true
+              type: String
+              description: (generate_portal_link.return_url)
+            - key: builder()
+              type: GeneratePortalLinkOptionsBuilder
+              description: (java.builder)
+      returns:
+        - key: response
+          type: Link
+          expanded: true
+          properties:
+            - key: link
+              type: String
+              description: (portal_link.link)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/admin-portal/portal-link/generate.mdx
+---
+
+## Generate a Portal Link
+
+Generate a Portal Link scoped to an Organization.
+
+<CodeBlock referenceId="generate_portal_link">
+  <CodeBlockTab title="Request" file="generate-portal-link-request" />
+  <CodeBlockTab title="Response" file="generate-portal-link-response" />
+</CodeBlock>

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

@@ -0,0 +1,15 @@
+---
+descriptions:
+  portal_link:
+    link: An ephemeral link to initiate the Admin Portal.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/admin-portal/portal-link/index.mdx
+---
+
+## Portal Link
+
+A Portal Link is a temporary endpoint to initiate an Admin Portal session. It expires five minutes after issuance.
+
+```url title="Example Portal Link URL"
+https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
+```

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

@@ -0,0 +1,52 @@
+---
+externalAssets:
+  providerIcons: 'https://cdn.workos.com/provider-icons.json'
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/admin-portal/provider-icons/index.mdx
+---
+
+## 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
+
+Get a list of all of existing provider icons.
+
+<CodeBlock referenceId="list_provider_icons">
+  <CodeBlockTab title="Request" file="list-provider-icons-request" />
+  <CodeBlockTab
+    title="Response"
+    file="https://cdn.workos.com/provider-icons.json"
+  />
+</CodeBlock>
+
+<ProviderIconsGrid
+  icons={externalAssets.providerIcons}
+  figmaURL="https://www.figma.com/community/file/1408148024751538607/provider-icons"
+/>
+
+### 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.
+
+```html title="Example icon"
+<picture>
+  <source
+    srcset="https://cdn.workos.com/provider-icons/dark/okta.svg"
+    media="(prefers-color-scheme: dark)"
+  />
+  <img
+    src="https://cdn.workos.com/provider-icons/light/okta.svg"
+    alt="Okta icon"
+  />
+</picture>
+```
+
+You can change the icons to grayscale by adding the `filter` CSS property.
+
+```css title="Grayscale style"
+img {
+  filter: grayscale(100%);
+}
+```

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

@@ -0,0 +1,22 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/api-keys.mdx
+---
+# API Keys
+
+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" />
+
+You can view and manage your API keys in the [WorkOS Dashboard](https://dashboard.workos.com/api-keys).
+
+## Secure your API Keys
+
+API keys can perform any API request to WorkOS. They should be kept secure and private! Be sure to prevent API keys from being made publicly accessible, such as in client-side code, GitHub, unsecured S3 buckets, and so forth. API keys are prefixed with `sk_`.
+
+## In Staging
+
+Your Staging Environment comes with an API key already generated for you. Staging API keys may be viewed as often as they are needed and will appear inline throughout our documentation in code examples if you are logged in to your WorkOS account. API requests will be scoped to the provided key’s Environment.
+
+## In Production
+
+Once you unlock Production access you will need to generate an API Key for it. Production API keys may only be viewed once and will need to be saved in a secure location upon creation of them.

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

@@ -0,0 +1,239 @@
+---
+descriptions:
+  audit_log_export:
+    self: 'The [Audit Log Export](/reference/audit-logs/audit-log-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.
+    updated_at: The timestamp when the Audit Log Export was last updated.
+    state:
+      lowercase: |
+        The state of the export. Possible values:
+        - `pending`
+        - `ready`
+        - `error`.
+      titlecase: |
+        The state of the export. Possible values:
+        - `Pending`
+        - `Ready`
+        - `Error`.
+    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
+      key: audit_log_export
+      id: audit_log_export
+      title: audit_log_export
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: string
+          description: (audit_log_export.id)
+        - key: created_at
+          type: string
+          description: (audit_log_export.created_at)
+        - key: updated_at
+          type: string
+          description: (audit_log_export.updated_at)
+        - key: state
+          type: |
+            "pending" | "ready" | "error"
+          description: (audit_log_export.state.lowercase)
+        - key: url
+          type: string
+          optional: true
+          description: (audit_log_export.url)
+  js:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: interface AuditLogExport
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: string
+          description: (audit_log_export.id)
+        - key: createdAt
+          type: string
+          description: (audit_log_export.created_at)
+        - key: updatedAt
+          type: string
+          description: (audit_log_export.updated_at)
+        - key: state
+          type: |
+            "pending" | "ready" | "error"
+          description: (audit_log_export.state.lowercase)
+        - key: url
+          type: string
+          optional: true
+          description: (audit_log_export.url)
+  java:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: class AuditLogExport
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: String
+          description: (audit_log_export.id)
+        - key: state
+          type: AuditLogExportState
+          description: (audit_log_export.state.titlecase)
+        - key: url
+          type: String
+          optional: true
+          description: (audit_log_export.url)
+        - key: createdAt
+          type: Date
+          description: (audit_log_export.created_at)
+        - key: updatedAt
+          type: Date
+          description: (audit_log_export.updated_at)
+  dotnet:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: class AuditLogExport
+      properties:
+        - key: Object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: Id
+          type: string
+          description: (audit_log_export.id)
+        - key: CreatedAt
+          type: string
+          description: (audit_log_export.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (audit_log_export.updated_at)
+        - key: State
+          type: AuditLogExportState
+          description: (audit_log_export.state.lowercase)
+        - key: Url
+          type: string
+          optional: true
+          description: (audit_log_export.url)
+  php:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: WorkOS\Resource\AuditLogExport
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: string
+          description: (audit_log_export.id)
+        - key: createdAt
+          type: string
+          description: (audit_log_export.created_at)
+        - key: updatedAt
+          type: string
+          description: (audit_log_export.updated_at)
+        - key: state
+          type: |
+            "pending"|"ready"|"error"
+          description: (audit_log_export.state.lowercase)
+        - key: url
+          type: string
+          optional: true
+          description: (audit_log_export.url)
+  python:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: AuditLogExport
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: str
+          description: (audit_log_export.id)
+        - key: created_at
+          type: str
+          description: (audit_log_export.created_at)
+        - key: updated_at
+          type: str
+          description: (audit_log_export.updated_at)
+        - key: state
+          type: |
+            "pending" | "ready" | "error"
+          description: (audit_log_export.state.lowercase)
+        - key: url
+          type: str
+          optional: true
+          description: (audit_log_export.url)
+  ruby:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: class AuditLogExport
+      properties:
+        - key: object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: id
+          type: String
+          description: (audit_log_export.id)
+        - key: created_at
+          type: String
+          description: (audit_log_export.created_at)
+        - key: updated_at
+          type: String
+          description: (audit_log_export.updated_at)
+        - key: state
+          type: |
+            "pending" | "ready" | "error"
+          description: (audit_log_export.state.lowercase)
+        - key: url
+          type: String
+          optional: true
+          description: (audit_log_export.url)
+  go:
+    - url: /reference/audit-logs/audit-log-export
+      key: AuditLogExport
+      id: audit_log_export
+      title: auditlogs.AuditLogExport
+      properties:
+        - key: Object
+          type: '"audit_log_export"'
+          description: (audit_log_export.object)
+        - key: ID
+          type: string
+          description: (audit_log_export.id)
+        - key: CreatedAt
+          type: string
+          description: (audit_log_export.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (audit_log_export.updated_at)
+        - key: State
+          type: auditlogs.AuditLogExportState
+          description: (audit_log_export.state.lowercase)
+        - key: URL
+          type: string
+          optional: true
+          description: (audit_log_export.url)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/audit-logs/audit-log-export.mdx
+---
+
+## Audit Log Export
+
+An object representing an Audit Log Export.
+
+<CodeBlock
+  title="Audit Log Export"
+  file="audit-log-export"
+  referenceId="audit_log_export"
+/>

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

@@ -0,0 +1,69 @@
+---
+descriptions:
+  audit_log_schema:
+    self: 'The [Audit Log Schema](/reference/audit-logs/audit-log-schema) object.'
+    object: Distinguishes the Audit Log Schema object.
+    version: The version of the schema.
+    targets: The list of targets for the schema.
+    actor: The metadata schema for the actor.
+    metadata: |
+      Additional data that should be associated with the event or entity.
+      There is a limit of 50 keys. Key names can be up to 40 characters long,
+      and values can be up to 500 characters long.
+    created_at: The timestamp when the Audit Log Schema was created.
+reference:
+  curl:
+    - url: /reference/audit-logs/audit-log-schema
+      key: audit_log_schema
+      id: audit_log_schema
+      title: audit_log_schema
+      properties:
+        - key: object
+          type: '"audit_log_schema"'
+          description: (audit_log_schema.object)
+        - key: version
+          type: number
+          description: (audit_log_schema.version)
+        - key: targets
+          type: array
+          description: (audit_log_schema.targets)
+        - key: actor
+          type: object
+          description: (audit_log_schema.actor)
+        - key: metadata
+          type: object
+          description: (audit_log_schema.metadata)
+  js:
+    - url: /reference/audit-logs/audit-log-schema
+      key: AuditLogSchema
+      id: audit_log_schema
+      title: interface AuditLogSchema
+      properties:
+        - key: object
+          type: '"audit_log_schema"'
+          description: (audit_log_schema.object)
+        - key: version
+          type: number
+          description: (audit_log_schema.version)
+        - key: targets
+          type: array
+          description: (audit_log_schema.targets)
+        - key: actor
+          type: object
+          description: (audit_log_schema.actor)
+        - key: metadata
+          type: object
+          description: (audit_log_schema.metadata)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/audit-logs/audit-log-schema.mdx
+---
+
+## Audit Log Schema
+
+An object representing an Audit Log Schema.
+
+<CodeBlock
+  title="Audit Log Schema"
+  file="audit-log-schema"
+  referenceId="audit_log_schema"
+/>