@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/organization/update.mdx

@@ -0,0 +1,236 @@
+---
+reference:
+  curl:
+    - key: update_organization
+      id: update_organization
+      url: /reference/organization/update
+      title: '/organizations/:id'
+      type: PUT
+      parameters:
+        - (organization.name)
+        - key: domain_data
+          optional: true
+          type: array
+          properties:
+            - key: domain
+              type: string
+              description: (domain_data.domain)
+            - key: state
+              type: '"pending" | "verified"'
+              description: (domain_data.state)
+        - key: stripe_customer_id
+          optional: true
+          type: string
+          description: (organization.stripe_customer_id)
+        - key: external_id
+          optional: true
+          type: string
+          description: (organization.external_id)
+        - key: metadata
+          optional: true
+          type: object
+          description: (organization.metadata)
+      returns:
+        - (organization)
+  js:
+    - key: updateOrganization
+      id: update_organization
+      url: /reference/organization/update
+      title: organizations.updateOrganization()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organization
+              type: string
+              description: (organization.id)
+            - (Organization.name)
+            - key: domainData
+              optional: true
+              type: 'object[]'
+              properties:
+                - key: domain
+                  type: string
+                  description: (domain_data.domain)
+                - key: state
+                  type: '"pending" | "verified"'
+                  description: (domain_data.state)
+            - key: stripeCustomerId
+              optional: true
+              type: string
+              description: (organization.stripe_customer_id)
+            - key: externalId
+              optional: true
+              type: string
+              description: (organization.external_id)
+            - key: metadata
+              optional: true
+              type: object
+              description: (organization.metadata)
+      returns:
+        - (Organization)
+  go:
+    - key: UpdateOrganization
+      id: update_organization
+      url: /reference/organization/update
+      title: organizations.UpdateOrganization()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: organizations.UpdateOrganizationOpts
+          expanded: true
+          properties:
+            - key: Organization
+              type: string
+              description: (organization.id)
+            - (Organization.Name)
+            - key: DomainData
+              optional: true
+              type: '[]OrganizationDomainData'
+              properties:
+                - key: Domain
+                  type: string
+                  description: (domain_data.domain)
+                - key: State
+                  type: OrganizationDomainDataState
+                  description: (domain_data.state)
+      returns:
+        - key: org
+          type: organizations.Organization
+          description: (organization.self)
+        - (err)
+  java:
+    - key: updateOrganization
+      id: update_organization
+      url: /reference/organization/update
+      title: organizations.updateOrganization()
+      parameters:
+        - (Organization.id)
+        - key: options
+          type: UpdateOrganizationOptions
+          expanded: true
+          properties:
+            - (Organization.name)
+            - key: domainData
+              optional: true
+              type: List<OrganizationDomainDataOptions>
+              properties:
+                - key: domain
+                  type: String
+                  description: (domain_data.domain)
+                - key: state
+                  type: OrganizationDomainDataState
+                  description: (domain_data.state)
+            - key: builder()
+              type: UpdateOrganizationOptionsBuilder
+              description: (java.builder)
+      returns:
+        - (Organization)
+  ruby:
+    - key: update_organization
+      id: update_organization
+      url: /reference/organization/update
+      title: Organizations.update_organization()
+      parameters:
+        - key: organization
+          type: String
+          description: (organization.id)
+        - (Organization.name)
+        - key: domain_data
+          optional: true
+          type: 'Array[Hash]'
+          properties:
+            - key: domain
+              type: String
+              description: (domain_data.domain)
+            - key: state
+              type: '"pending" | "verified"'
+              description: (domain_data.state)
+      returns:
+        - (Organization)
+  python:
+    - key: update_organization
+      id: update_organization
+      url: /reference/organization/update
+      title: organizations.update_organization()
+      parameters:
+        - key: organization
+          type: str
+          description: (organization.id)
+        - (Organization.name)
+        - key: domain_data
+          optional: true
+          type: 'Sequence[DomainDataInput]'
+          properties:
+            - key: domain
+              type: string
+              description: (domain_data.domain)
+            - key: state
+              type: '"pending" | "verified"'
+              description: (domain_data.state)
+      returns:
+        - (Organization)
+  php:
+    - key: updateOrganization
+      id: update_organization
+      url: /reference/organization/update
+      title: $organizations->updateOrganization()
+      parameters:
+        - key: organization
+          type: string
+          description: (organization.id)
+        - key: domain_data
+          optional: true
+          type: 'object[]'
+          properties:
+            - key: domain
+              type: string
+              description: (domain_data.domain)
+            - key: state
+              type: '"pending" | "verified"'
+              description: (domain_data.state)
+        - (Organization.name)
+      returns:
+        - (Organization)
+  dotnet:
+    - key: UpdateOrganization
+      id: update_organization
+      url: /reference/organization/update
+      title: organizationsService.UpdateOrganization()
+      parameters:
+        - key: options
+          type: UpdateOrganizationOptions
+          expanded: true
+          properties:
+            - key: Organization
+              type: string
+              description: (organization.id)
+            - (Organization.Name)
+            - key: DomainData
+              type: 'OrganizationDomainDataOptions[]'
+              optional: true
+              properties:
+                - key: Domain
+                  type: string
+                  description: (domain_data.domain)
+                - key: State
+                  type: OrganizationDomainDataState
+                  description: (domain_data.state)
+        - (cancellationToken)
+      returns:
+        - key: Task<Organization>
+          description: (organization.self)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/update.mdx
+---
+
+## Update an Organization
+
+Updates an organization in the current environment.
+
+You can include one or more domains to associate with the organization, but you should [verify the ownership](/user-management/domain-verification) of every domain before setting its state to `verified`.
+
+<CodeBlock referenceId="update_organization">
+  <CodeBlockTab title="Request" file="update-organization-request" />
+  <CodeBlockTab title="Response" file="update-organization-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/organization-domain.mdx

@@ -0,0 +1,189 @@
+---
+descriptions:
+  legacy_organization_domain:
+    id: Unique identifier for the Organization Domain.
+    domain: Domain for the Organization Domain.
+    object: Distinguishes the Organization Domain object.
+    organization_id: The ID of the Organization associated with the Organization Domain.
+    state: >
+      The verification state of the Organization Domain.
+
+
+      A “pending” state means the Organization Domain has not been verified yet.
+
+      For example, the organization that owns the domain may need to set a DNS
+      record to verify ownership.
+
+
+      If DNS verification fails, the Organization Domain moves to a “failed”
+      state.
+
+
+      Once ownership has been verified, the OrganizationDomain moves to a
+      “verified” state.
+
+
+      The “legacy verified” state is being phased out, and is used for
+      organizations that have not yet transitioned to the current domain-policy
+      flow.
+    verification_strategy: >
+      How the Organization Domain was verified.
+
+
+      - `dns` means the Organization admin set a DNS record (based on the value
+      of `verification_token`) to prove ownership.
+
+      - `manual` indicates the domain was verified manually via the API or the
+      Dashboard.
+    verification_token: >-
+      When the verification strategy is `dns`, this token must be present in a
+      DNS record to verify the Organization Domain.
+reference:
+  curl:
+    - url: /reference/organization-domain
+      key: legacy_organization_domain
+      id: legacy_organization_domain
+      title: organization_domain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: string
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: string
+          description: (legacy_organization_domain.domain)
+        - key: organization_id
+          type: string
+          description: (legacy_organization_domain.organization_id)
+        - key: state
+          type: '"verified" | "pending" | "failed" | "legacy_verified"'
+          description: (legacy_organization_domain.state)
+        - key: verification_strategy
+          type: '"manual" | "dns"'
+          description: (legacy_organization_domain.verification_strategy)
+        - key: verification_token?
+          type: string
+          description: (legacy_organization_domain.verification_token)
+  js:
+    - url: /reference/organization-domain
+      key: LegacyOrganizationDomain
+      id: legacy_organization_domain
+      title: interface OrganizationDomain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: string
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: string
+          description: (legacy_organization_domain.domain)
+  go:
+    - url: /reference/organization-domain
+      key: LegacyOrganizationDomain
+      id: legacy_organization_domain
+      title: organizations.OrganizationDomain
+      properties:
+        - key: ID
+          type: string
+          description: (legacy_organization_domain.id)
+        - key: Domain
+          type: string
+          description: (legacy_organization_domain.domain)
+  java:
+    - url: /reference/organization-domain
+      key: LegacyOrganizationDomain
+      id: legacy_organization_domain
+      title: class OrganizationDomain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: String
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: String
+          description: (legacy_organization_domain.domain)
+  python:
+    - url: /reference/organization-domain
+      key: legacy_organization_domain
+      id: legacy_organization_domain
+      title: OrganizationDomain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: str
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: str
+          description: (legacy_organization_domain.domain)
+  ruby:
+    - url: /reference/organization-domain
+      key: legacy_organization_domain
+      id: legacy_organization_domain
+      title: Hash organization_domain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: String
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: String
+          description: (legacy_organization_domain.domain)
+  php:
+    - url: /reference/organization-domain
+      key: legacy_organization_domain
+      id: legacy_organization_domain
+      title: $organizationDomain
+      properties:
+        - key: object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: id
+          type: string
+          description: (legacy_organization_domain.id)
+        - key: domain
+          type: string
+          description: (legacy_organization_domain.domain)
+  dotnet:
+    - url: /reference/organization-domain
+      key: LegacyOrganizationDomain
+      id: legacy_organization_domain
+      title: class OrganizationDomain
+      properties:
+        - key: Object
+          type: '"organization_domain"'
+          description: (legacy_organization_domain.object)
+        - key: Id
+          type: string
+          description: (legacy_organization_domain.id)
+        - key: Domain
+          type: string
+          description: (legacy_organization_domain.domain)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/organization-domain.mdx
+---
+
+## Organization Domain
+
+An Organization Domain (also known as a User Email Domain) represents an [Organization](/reference/organization)'s domain.
+
+These domains restrict which email addresses are able to sign in through SAML Connections when [allow profiles outside organization](/reference/organization) is `false`. This is the default behavior for Organizations. See [SSO frequently asked questions](/sso/launch-checklist/frequently-asked-questions) for more details on this behavior.
+
+Organization domains can be verified manually (through the API or the Dashboard), or through [a self-serve flow](/domain-verification) through 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`.
+
+<CodeBlock
+  title="Example Organization Domain"
+  file="organization-domain"
+  referenceId="legacy_organization_domain"
+/>

package/.docs/organized/docs/reference/pagination.mdx

@@ -0,0 +1,244 @@
+---
+descriptions:
+  limit: >
+    Upper limit on the number of objects to return, between `1` and `100`. The
+    default value is `10`.
+  order:
+    lowercase: >
+      Order the results by the creation time. Supported values are `"asc"` and
+      `"desc"` for showing older and newer records first respectively. Default
+      order is descending.
+    titlecase: >
+      Order the results by the creation time. Supported values are `Asc` and
+      `Desc` for showing older and newer records first respectively. Default
+      order is descending.
+  before: >
+    An object ID that defines your place in the list. When the ID is not
+    present, you are at the end of the list.
+
+
+    For example, if you make a list request and receive 100 objects, ending with
+    `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a
+    new batch of objects before `"obj_123"`.
+  after: >
+    An object ID that defines your place in the list. When the ID is not
+    present, you are at the end of the list.
+
+
+    For example, if you make a list request and receive 100 objects, ending with
+    `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a
+    new batch of objects after `"obj_123"`.
+reference:
+  curl:
+    - key: list_metadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: number
+      description: (limit)
+    - key: order
+      optional: true
+      type: '"asc" | "desc"'
+      description: (order.lowercase)
+    - key: before
+      optional: true
+      type: string
+      description: (before)
+    - key: after
+      optional: true
+      type: string
+      description: (after)
+  js:
+    - key: ListMetadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: number
+      description: (limit)
+    - key: order
+      optional: true
+      type: '"asc" | "desc"'
+      description: (order.lowercase)
+    - key: before
+      optional: true
+      type: string
+      description: (before)
+    - key: after
+      optional: true
+      type: string
+      description: (after)
+  go:
+    - key: ListMetadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (Before)
+        - (After)
+        - (Limit)
+        - (Order)
+    - key: Limit
+      optional: true
+      type: int
+      description: (limit)
+    - key: Order
+      optional: true
+      type: common.Order
+      description: (order.titlecase)
+    - key: Before
+      optional: true
+      type: string
+      description: (before)
+    - key: After
+      optional: true
+      type: string
+      description: (after)
+  java:
+    - key: listMetadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: Int
+      description: (limit)
+    - key: order
+      optional: true
+      type: Order
+      description: (order.titlecase)
+    - key: before
+      optional: true
+      type: String
+      description: (before)
+    - key: after
+      optional: true
+      type: String
+      description: (after)
+  ruby:
+    - key: list_metadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: Integer
+      description: (limit)
+    - key: order
+      optional: true
+      type: '"asc" | "desc"'
+      description: (order.lowercase)
+    - key: before
+      optional: true
+      type: String
+      description: (before)
+    - key: after
+      optional: true
+      type: String
+      description: (after)
+  python:
+    - key: list_metadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: int
+      description: (limit)
+    - key: order
+      optional: true
+      type: '"asc" | "desc"'
+      description: (order.lowercase)
+    - key: before
+      optional: true
+      type: str
+      description: (before)
+    - key: after
+      optional: true
+      type: str
+      description: (after)
+  php:
+    - key: ListMetadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (before)
+        - (after)
+        - (limit)
+        - (order)
+    - key: limit
+      optional: true
+      type: int
+      description: (limit)
+    - key: order
+      optional: true
+      type: '"asc"|"desc"'
+      description: (order.lowercase)
+    - key: before
+      optional: true
+      type: string
+      description: (before)
+    - key: after
+      optional: true
+      type: string
+      description: (after)
+  dotnet:
+    - key: ListMetadata
+      id: list_metadata
+      url: /reference/pagination
+      parameters:
+        - (Before)
+        - (After)
+        - (Limit)
+        - (Order)
+    - key: Limit
+      optional: true
+      type: int
+      description: (limit)
+    - key: Order
+      optional: true
+      type: PaginationOrder
+      description: (order.titlecase)
+    - key: Before
+      optional: true
+      type: string
+      description: (before)
+    - key: After
+      optional: true
+      type: string
+      description: (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/pagination.mdx
+---
+
+# Pagination
+
+Many top-level resources have support for bulk fetches via list API methods. For instance, you can [list connections](/reference/sso/connection/list), [list directory users](/reference/directory-sync/directory-user/list), and [list directory groups](/reference/directory-sync/directory-group/list). These list API methods share a common structure, taking at least these four parameters: `limit`, `order`, `after`, and `before`.
+
+WorkOS utilizes pagination via the `after` and `before` parameters. Both parameters take an existing object ID value and return objects in either descending or ascending order by creation time.
+
+<CodeBlock referenceId="list_metadata">
+  <CodeBlockTab title="Request" file="list-metadata-request" />
+  <CodeBlockTab title="Response" file="list-metadata-response" />
+</CodeBlock>