@workos/mcp-docs-server 0.1.0 → 0.2.0

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

@@ -19,6 +19,35 @@ reference:
         - (Organization.id)
       returns:
         - (OrganizationDomain)
+  go:
+    - key: GetOrganizationDomain
+      id: get_organization_domain
+      url: /reference/domain-verification/get
+      title: organization_domains.GetOrganizationDomain()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: organization_domains.GetOrganizationDomainOpts
+          expanded: true
+          properties:
+            - key: DomainID
+              type: string
+              description: (organization_domain.id)
+      returns:
+        - key: organizationDomain
+          type: OrganizationDomain
+        - (err)
+  python:
+    - key: get_organization_domain
+      id: get_organization_domain
+      url: /reference/domain-verification/get
+      title: organization_domains.get_organization_domain()
+      parameters:
+        - key: organization_domain_id
+          type: str
+          description: (organization_domain.id)
+      returns:
+        - (OrganizationDomain)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/domain-verification/get.mdx
 ---
 

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

@@ -67,6 +67,57 @@ reference:
         - key: verificationToken
           type: string
           description: (organization_domain.verification_token)
+  go:
+    - url: /reference/domain-verification
+      key: OrganizationDomain
+      id: organization-domain
+      title: organization_domains.OrganizationDomain
+      properties:
+        - key: ID
+          type: string
+          description: (organization_domain.id)
+        - key: Domain
+          type: string
+          description: (organization_domain.domain)
+        - key: OrganizationID
+          type: string
+          description: (organization_domain.organization_id)
+        - key: State
+          type: OrganizationDomainState
+          description: (organization_domain.state)
+        - key: VerificationStrategy
+          type: OrganizationDomainVerificationStrategy
+          description: (organization_domain.verification_strategy)
+        - key: VerificationToken
+          type: string
+          description: (organization_domain.verification_token)
+  python:
+    - url: /reference/domain-verification
+      key: OrganizationDomain
+      id: organization-domain
+      title: OrganizationDomain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (organization_domain.object)
+        - key: id
+          type: str
+          description: (organization_domain.id)
+        - key: organization_id
+          type: str
+          description: (organization_domain.organization_id)
+        - key: domain
+          type: str
+          description: (organization_domain.domain)
+        - key: state
+          type: str
+          description: (organization_domain.state)
+        - key: verification_strategy
+          type: str
+          description: (organization_domain.verification_strategy)
+        - key: verification_token
+          type: str
+          description: (organization_domain.verification_token)
 originalPath: >-
   .tmp-workos-clone/packages/docs/content/reference/domain-verification/index.mdx
 ---
@@ -75,7 +126,12 @@ originalPath: >-
 
 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).
+Organization domains can be verified manually through the Dashboard, or by setting `state: 'verified'` when adding domains via the [Organization create](/reference/organization/create) or [update](/reference/organization/update) APIs. Domains can also be verified through [a self-serve flow](/domain-verification) via the Admin Portal.
+The organization that defines this domain policy exerts authentication policy control over that domain across your application.
+For this reason, it is important to verify ownership of manually added domains.
+Additionally, WorkOS does not allow addition of common consumer domains, like `gmail.com`.
+
+To automatically respond to changes in the organization domains, use [organization domain events](/events/organization-domain).
 
 <CodeBlock
   title="Example organization domain"

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

@@ -22,6 +22,35 @@ reference:
             - (OrganizationDomain.id)
       returns:
         - (OrganizationDomain)
+  go:
+    - key: VerifyOrganizationDomain
+      id: verify_organization_domain
+      url: /reference/domain-verification/verify
+      title: organization_domains.VerifyOrganizationDomain()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: organization_domains.VerifyOrganizationDomainOpts
+          expanded: true
+          properties:
+            - key: DomainID
+              type: string
+              description: (organization_domain.id)
+      returns:
+        - key: organizationDomain
+          type: OrganizationDomain
+        - (err)
+  python:
+    - key: verify_organization_domain
+      id: verify_organization_domain
+      url: /reference/domain-verification/verify
+      title: organization_domains.verify_organization_domain()
+      parameters:
+        - key: organization_domain_id
+          type: str
+          description: (organization_domain.id)
+      returns:
+        - (OrganizationDomain)
 originalPath: >-
   .tmp-workos-clone/packages/docs/content/reference/domain-verification/verify.mdx
 ---

package/.docs/organized/docs/reference/{errors.mdx → errors/index.mdx}

@@ -1,5 +1,5 @@
 ---
-originalPath: .tmp-workos-clone/packages/docs/content/reference/errors.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/errors/index.mdx
 ---
 # Errors
 

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

@@ -75,7 +75,7 @@ reference:
         - key: organizationId
           optional: true
           type: string
-          description: (list_events.limit)
+          description: (list_events.organization_id)
         - key: rangeStart
           optional: true
           type: string
@@ -122,7 +122,7 @@ reference:
             - key: OrganizationId
               optional: true
               type: int
-              description: (list_events.limit)
+              description: (list_events.organization_id)
             - key: RangeStart
               optional: true
               type: string
@@ -168,7 +168,7 @@ reference:
         - key: organization_id
           optional: true
           type: String
-          description: (list_events.limit)
+          description: (list_events.organization_id)
         - key: range_start
           optional: true
           type: String
@@ -205,10 +205,11 @@ reference:
         - key: limit
           optional: true
           type: int
+          description: (list_events.limit)
         - key: organization_id
           optional: true
           type: str
-          description: (list_events.limit)
+          description: (list_events.organization_id)
         - key: range_start
           optional: true
           type: str

package/.docs/organized/docs/reference/feature-flags/flag/disable.mdx

@@ -0,0 +1,33 @@
+---
+reference:
+  curl:
+    - key: disable_flag
+      id: disable_flag
+      url: /reference/feature-flags/disable-flag
+      title: '/feature-flags/:slug/disable'
+      type: PUT
+      parameters:
+        - (feature_flag.slug)
+      returns:
+        - (feature_flag)
+  js:
+    - key: disableFlag
+      id: disable_flag
+      url: /reference/feature-flags/disable-flag
+      title: featureFlags.disableFeatureFlag()
+      parameters:
+        - (FeatureFlag.slug)
+      returns:
+        - (FeatureFlag)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/flag/disable.mdx
+---
+
+## Disable flag
+
+Disables a feature flag in the current environment.
+
+<CodeBlock referenceId="disable_flag">
+  <CodeBlockTab title="Request" file="disable-flag" />
+  <CodeBlockTab title="Response" file="disable-flag-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/feature-flags/flag/enable.mdx

@@ -0,0 +1,33 @@
+---
+reference:
+  curl:
+    - key: enable_flag
+      id: enable_flag
+      url: /reference/feature-flags/enable-flag
+      title: '/feature-flags/:slug/enable'
+      type: PUT
+      parameters:
+        - (feature_flag.slug)
+      returns:
+        - (feature_flag)
+  js:
+    - key: enableFlag
+      id: enable_flag
+      url: /reference/feature-flags/enable-flag
+      title: featureFlags.enableFeatureFlag()
+      parameters:
+        - (FeatureFlag.slug)
+      returns:
+        - (FeatureFlag)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/flag/enable.mdx
+---
+
+## Enable flag
+
+Enables a feature flag in the current environment.
+
+<CodeBlock referenceId="enable_flag">
+  <CodeBlockTab title="Request" file="enable-flag" />
+  <CodeBlockTab title="Response" file="enable-flag-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/feature-flags/flag/get.mdx

@@ -0,0 +1,32 @@
+---
+reference:
+  curl:
+    - key: get_feature_flag
+      id: get_feature_flag
+      url: /reference/feature-flags/get
+      title: '/feature-flags/:slug'
+      type: GET
+      parameters:
+        - (feature_flag.slug)
+      returns:
+        - (feature_flag)
+  js:
+    - key: getFeatureFlag
+      id: get_feature_flag
+      url: /reference/feature-flags/get
+      title: featureFlags.getFeatureFlag()
+      parameters:
+        - (FeatureFlag.slug)
+      returns:
+        - (FeatureFlag)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/feature-flags/flag/get.mdx
+---
+
+## Get a feature flag
+
+Get the details of an existing feature flag.
+
+<CodeBlock referenceId="get_feature_flag">
+  <CodeBlockTab title="Request" file="get-feature-flag-request" />
+  <CodeBlockTab title="Response" file="get-feature-flag-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/feature-flags/flag/index.mdx

@@ -0,0 +1,116 @@
+---
+descriptions:
+  feature_flag:
+    self: 'The [Feature Flag](/reference/feature-flags) object.'
+    object: Distinguishes the Feature Flag object
+    id: Unique identifier of the Feature Flag.
+    name: >-
+      A descriptive name for the Feature Flag. This field does not need to be
+      unique.
+    slug: A unique key to reference the Feature Flag.
+    description: A description for the Feature Flag.
+    tags: Labels assigned to the Feature Flag for categorizing and filtering.
+    enabled: Specifies whether the Feature Flag is active for the current environment.
+    default_value: >-
+      The value returned for users and organizations who don't match any
+      configured targeting rules.
+    created_at: The timestamp when the Feature Flag was last created.
+    updated_at: The timestamp when the Feature Flag was last updated.
+reference:
+  curl:
+    - url: /reference/feature-flags/flag
+      key: feature_flag
+      id: feature_flag
+      title: feature_flag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: string
+          description: (feature_flag.id)
+        - key: name
+          type: string
+          description: (feature_flag.name)
+        - key: slug
+          type: string
+          description: (feature_flag.slug)
+        - key: description
+          type: string | null
+          description: (feature_flag.description)
+        - key: tags
+          type: array
+          description: (feature_flag.tags)
+        - key: enabled
+          type: boolean
+          description: (feature_flag.enabled)
+        - key: default_value
+          type: boolean
+          description: (feature_flag.default_value)
+        - key: created_at
+          type: string
+          description: (feature_flag.created_at)
+        - key: updated_at
+          type: string
+          description: (feature_flag.updated_at)
+  js:
+    - url: /reference/feature-flags/flag
+      key: FeatureFlag
+      id: feature_flag
+      title: interface FeatureFlag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: string
+          description: (feature_flag.id)
+        - key: name
+          type: string
+          description: (feature_flag.name)
+        - key: slug
+          type: string
+          description: (feature_flag.slug)
+        - key: description
+          type: string | null
+          description: (feature_flag.description)
+        - key: createdAt
+          type: string
+          description: (feature_flag.created_at)
+        - key: updatedAt
+          type: string
+          description: (feature_flag.updated_at)
+  ruby:
+    - url: /reference/feature-flags/flag
+      key: feature_flag
+      id: feature_flag
+      title: class FeatureFlag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: String
+          description: (feature_flag.id)
+        - key: name
+          type: String
+          description: (feature_flag.name)
+        - key: slug
+          type: String
+          description: (feature_flag.slug)
+        - key: description
+          type: String
+          optional: true
+          description: (feature_flag.description)
+        - key: created_at
+          type: String
+          description: (feature_flag.created_at)
+        - key: updated_at
+          type: String
+          description: (feature_flag.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/feature-flags/flag/index.mdx
+---
+
+# Feature Flag
+
+A Feature Flag controls feature availability for organizations and users in your application.

package/.docs/organized/docs/reference/feature-flags/flag/list.mdx

@@ -0,0 +1,67 @@
+---
+descriptions:
+  list_feature_flags:
+    data: 'Array of [Feature Flags](/reference/feature-flags).'
+reference:
+  curl:
+    - key: list_feature_flags
+      id: list_feature_flags
+      url: /reference/feature-flags/list
+      title: /feature-flags
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_feature_flags.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listFeatureFlags
+      id: list_feature_flags
+      url: /reference/feature-flags/list
+      title: featureFlags.listFeatureFlags()
+      parameters:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'FeatureFlag[]'
+              description: (list_feature_flags.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/feature-flags/flag/list.mdx
+---
+
+## List feature flags
+
+Get a list of all of your existing feature flags matching the criteria specified.
+
+<CodeBlock referenceId="list_feature_flags">
+  <CodeBlockTab title="Request" file="list-feature-flags-request" />
+  <CodeBlockTab title="Response" file="list-feature-flags-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/feature-flags/index.mdx

@@ -0,0 +1,123 @@
+---
+title: Feature Flags
+descriptions:
+  feature_flag:
+    self: 'The [Feature Flag](/reference/feature-flags) object.'
+    object: Distinguishes the Feature Flag object
+    id: Unique identifier of the Feature Flag.
+    name: >-
+      A descriptive name for the Feature Flag. This field does not need to be
+      unique.
+    slug: A unique key to reference the Feature Flag.
+    description: A description for the Feature Flag.
+    tags: Labels assigned to the Feature Flag for categorizing and filtering.
+    enabled: Specifies whether the Feature Flag is active for the current environment.
+    default_value: >-
+      The value returned for users and organizations who don't match any
+      configured targeting rules.
+    created_at: The timestamp when the Feature Flag was last created.
+    updated_at: The timestamp when the Feature Flag was last updated.
+reference:
+  curl:
+    - url: /reference/feature-flags
+      key: feature_flag
+      id: feature_flag
+      title: Feature Flag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: string
+          description: (feature_flag.id)
+        - key: name
+          type: string
+          description: (feature_flag.name)
+        - key: slug
+          type: string
+          description: (feature_flag.slug)
+        - key: description
+          type: string | null
+          description: (feature_flag.description)
+        - key: tags
+          type: array
+          description: (feature_flag.tags)
+        - key: enabled
+          type: boolean
+          description: (feature_flag.enabled)
+        - key: default_value
+          type: boolean
+          description: (feature_flag.default_value)
+        - key: created_at
+          type: string
+          description: (feature_flag.created_at)
+        - key: updated_at
+          type: string
+          description: (feature_flag.updated_at)
+  js:
+    - url: /reference/feature-flags
+      key: FeatureFlag
+      id: feature_flag
+      title: interface FeatureFlag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: string
+          description: (feature_flag.id)
+        - key: name
+          type: string
+          description: (feature_flag.name)
+        - key: slug
+          type: string
+          description: (feature_flag.slug)
+        - key: description
+          type: string | null
+          description: (feature_flag.description)
+        - key: createdAt
+          type: string
+          description: (feature_flag.created_at)
+        - key: updatedAt
+          type: string
+          description: (feature_flag.updated_at)
+  ruby:
+    - url: /reference/feature-flags
+      key: feature_flag
+      id: feature_flag
+      title: class FeatureFlag
+      properties:
+        - key: object
+          type: '"feature_flag"'
+          description: (feature_flag.object)
+        - key: id
+          type: String
+          description: (feature_flag.id)
+        - key: name
+          type: String
+          description: (feature_flag.name)
+        - key: slug
+          type: String
+          description: (feature_flag.slug)
+        - key: description
+          type: String
+          optional: true
+          description: (feature_flag.description)
+        - key: created_at
+          type: String
+          description: (feature_flag.created_at)
+        - key: updated_at
+          type: String
+          description: (feature_flag.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/feature-flags/index.mdx
+---
+
+# Feature Flags
+
+Feature flags allow you to control feature availability for organizations in your application. Flags can either be enabled for individual organizations or all organizations in an environment. Read more about [how feature flags integrate with AuthKit here.](/feature-flags)
+
+<CodeBlock
+  title="Example Feature Flag"
+  file="feature-flag"
+  referenceId="feature_flag"
+/>

package/.docs/organized/docs/reference/feature-flags/targeting/add.mdx

@@ -0,0 +1,43 @@
+---
+descriptions:
+  add_flag_target:
+    target_id: The ID of the target to enable the Feature Flag for.
+reference:
+  curl:
+    - key: add_flag_target
+      id: add_flag_target
+      url: /reference/feature-flags/add-flag-target
+      title: '/feature-flags/:slug/targets/:target_id'
+      type: POST
+      parameters:
+        - (feature_flag.slug)
+        - key: target_id
+          type: string
+          description: (add_flag_target.target_id)
+  js:
+    - key: addFlagTarget
+      id: add_flag_target
+      url: /reference/feature-flags/add-flag-target
+      title: featureFlags.addFlagTarget()
+      parameters:
+        - key: options
+          type: object
+          expanded: true
+          properties:
+            - (FeatureFlag.slug)
+            - key: target_id
+              type: string
+              description: (add_flag_target.target_id)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/targeting/add.mdx
+---
+
+## Add flag target
+
+Enables a feature flag for a specific target in the current environment. Currently, supported targets include users and organizations.
+
+<CodeBlock
+  title="Request"
+  file="add-flag-target"
+  referenceId="add_flag_target"
+/>

package/.docs/organized/docs/reference/feature-flags/targeting/index.mdx

@@ -0,0 +1,23 @@
+---
+descriptions:
+  flag_target:
+    target_id: >-
+      The ID of the target (user or organization) that a Feature Flag is enabled
+      for.
+reference:
+  curl:
+    - url: /reference/feature-flags/targeting
+      key: flag_target
+      id: flag_target
+      title: flag_target
+      properties:
+        - key: target_id
+          type: string
+          description: (flag_target.target_id)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/targeting/index.mdx
+---
+
+# Targeting
+
+Targeting allows you to enable Feature Flags for specific users or organizations. When a flag is enabled for a target, that target will receive the flag's enabled value instead of the default value.