@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/organization-membership/index.mdx

@@ -0,0 +1,265 @@
+---
+descriptions:
+  organization_membership:
+    self: >-
+      The corresponding [organization
+      membership](/reference/user-management/organization-membership) object.
+    object: Distinguishes the organization membership object.
+    id: The unique ID of the organization membership.
+    user_id: 'The ID of the [user](/reference/user-management/user).'
+    organization_id: >-
+      The ID of the [organization](/reference/organization) which the user
+      belongs to.
+    role:
+      slug: The unique role identifier
+    status: >-
+      The status of the organization membership. One of `active`, `inactive`, or
+      `pending`.
+    created_at: The timestamp when the organization membership was created.
+    updated_at: The timestamp when the organization membership was last updated.
+reference:
+  curl:
+    - url: /reference/user-management/organization-membership
+      key: organization_membership
+      id: organization_membership
+      title: organization_membership
+      properties:
+        - key: object
+          type: '"organization_membership"'
+          description: (organization_membership.object)
+        - key: id
+          type: string
+          description: (organization_membership.id)
+        - key: userId
+          type: string
+          description: (organization_membership.user_id)
+        - key: organizationId
+          type: string
+          description: (organization_membership.organization_id)
+        - key: role
+          type: object
+          description: (organization_membership.role)
+          expanded: true
+          properties:
+            - key: slug
+              type: string
+              description: (organization_membership.role.slug)
+        - key: status
+          type: '"active" | "inactive" | "pending"'
+          description: (organization_membership.status)
+        - key: createdAt
+          type: string
+          description: (organization_membership.created_at)
+        - key: updatedAt
+          type: string
+          description: (organization_membership.updated_at)
+  js:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: interface OrganizationMembership
+      properties:
+        - key: object
+          type: '"organization_membership"'
+          description: (organization_membership.object)
+        - key: id
+          type: string
+          description: (organization_membership.id)
+        - key: userId
+          type: string
+          description: (organization_membership.user_id)
+        - key: organizationId
+          type: string
+          description: (organization_membership.organization_id)
+        - key: role
+          type: object
+          description: (organization_membership.role)
+          properties:
+            - key: slug
+              type: string
+              description: (organization_membership.role.slug)
+        - key: status
+          type: '"active" | "inactive" | "pending"'
+          description: (organization_membership.status)
+        - key: createdAt
+          type: string
+          description: (organization_membership.created_at)
+        - key: updatedAt
+          type: string
+          description: (organization_membership.updated_at)
+  go:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: usermanagement.OrganizationMembership
+      properties:
+        - key: ID
+          type: string
+          description: (organization_membership.id)
+        - key: UserID
+          type: string
+          description: (organization_membership.user_id)
+        - key: OrganizationID
+          type: string
+          description: (organization_membership.organization_id)
+        - key: Role
+          type: RoleResponse
+          description: (organization_membership.role)
+          properties:
+            - key: Slug
+              type: string
+              description: (organization_membership.role.slug)
+        - key: Status
+          type: '"active" | "inactive" | "pending"'
+          description: (organization_membership.status)
+        - key: CreatedAt
+          type: string
+          description: (organization_membership.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (organization_membership.updated_at)
+  php:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: WorkOS\Resource\OrganizationMembership
+      properties:
+        - key: object
+          type: '"organization_membership"'
+          description: (organization_membership.object)
+        - key: id
+          type: string
+          description: (organization_membership.id)
+        - key: userId
+          type: string
+          description: (organization_membership.user_id)
+        - key: organizationId
+          type: string
+          description: (organization_membership.organization_id)
+        - key: role
+          type: object
+          description: (organization_membership.role)
+          properties:
+            - key: slug
+              type: string
+              description: (organization_membership.role.slug)
+        - key: status
+          type: '"active" | "inactive" | "pending"'
+          description: (organization_membership.status)
+        - key: createdAt
+          type: string
+          description: (organization_membership.created_at)
+        - key: updatedAt
+          type: string
+          description: (organization_membership.updated_at)
+  python:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: OrganizationMembership
+      properties:
+        - key: id
+          type: str
+          description: (organization_membership.id)
+        - key: user_id
+          type: str
+          description: (organization_membership.user_id)
+        - key: organization_id
+          type: str
+          description: (organization_membership.organization_id)
+        - key: role
+          type: OrganizationMembershipRole
+          description: (organization_membership.role)
+          properties:
+            - key: slug
+              type: str
+              description: (organization_membership.role.slug)
+        - key: status
+          type: '"active" | "inactive" | "pending"'
+          description: (organization_membership.status)
+        - key: created_at
+          type: str
+          description: (organization_membership.created_at)
+        - key: updated_at
+          type: str
+          description: (organization_membership.updated_at)
+  ruby:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: class OrganizationMembership
+      properties:
+        - key: id
+          type: String
+          description: (organization_membership.id)
+        - key: user_id
+          type: String
+          description: (organization_membership.user_id)
+        - key: organization_id
+          type: String
+          description: (organization_membership.organization_id)
+        - key: role
+          type: object
+          description: (organization_membership.role)
+          properties:
+            - key: slug
+              type: String
+              description: (organization_membership.role.slug)
+        - key: status
+          type: String
+          description: (organization_membership.status)
+        - key: created_at
+          type: String
+          description: (organization_membership.created_at)
+        - key: updated_at
+          type: String
+          description: (organization_membership.updated_at)
+  java:
+    - url: /reference/user-management/organization-membership
+      key: OrganizationMembership
+      id: organization_membership
+      title: class OrganizationMembership
+      properties:
+        - key: id
+          type: String
+          description: (organization_membership.id)
+        - key: userId
+          type: String
+          description: (organization_membership.user_id)
+        - key: organizationId
+          type: String
+          description: (organization_membership.organization_id)
+        - key: role
+          type: OrganizationMembershipRole
+          optional: true
+          description: (organization_membership.role)
+          properties:
+            - key: slug
+              type: String
+              description: (organization_membership.role.slug)
+        - key: status
+          type: OrganizationMembershipStatusEnumType
+          description: (organization_membership.status)
+        - key: createdAt
+          type: String
+          description: (organization_membership.created_at)
+        - key: updatedAt
+          type: String
+          description: (organization_membership.updated_at)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/index.mdx
+---
+
+---
+
+# Organization membership
+
+An organization membership is a top-level resource that represents a [user](/reference/user-management/user)’s relationship with an [organization](/reference/organization). A user may be a member of zero, one, or many organizations.
+
+See the [events reference](/events/organization-membership) documentation for the organization membership events.
+
+<CodeBlock
+  title="Example organization membership"
+  referenceId="organization_membership"
+  file="organization-membership"
+/>

package/.docs/organized/docs/reference/user-management/organization-membership/list.mdx

@@ -0,0 +1,291 @@
+---
+descriptions:
+  list_organization_memberships:
+    data: >-
+      Array of [organization
+      memberships](/reference/user-management/organization-membership) ordered
+      by creation time.
+reference:
+  curl:
+    - key: list_organization_memberships
+      id: list_organization_memberships
+      url: /reference/user-management/organization-membership/list
+      title: /user_management/organization_memberships
+      type: GET
+      parameters:
+        - key: user_id
+          optional: true
+          type: string
+          description: (organization_membership.user_id)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (organization_membership.organization_id)
+        - key: statuses
+          optional: true
+          type: array
+          description: >-
+            Filter by the status of the organization membership. Array including
+            any of `active`, `inactive`, or `pending`.
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_organization_memberships.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listOrganizationMemberships
+      id: list_organization_memberships
+      url: /reference/user-management/organization-membership/list
+      title: userManagement.listOrganizationMemberships()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: userId
+              type: string
+              optional: true
+              description: (organization_membership.user_id)
+            - key: organizationId
+              type: string
+              optional: true
+              description: (organization_membership.organization_id)
+            - key: statuses
+              optional: true
+              type: 'OrganizationMembershipStatus[]'
+              description: Filter by the status of the organization membership.
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_organization_memberships.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  go:
+    - key: ListOrganizationMemberships
+      patternBefore: usermanagement.
+      id: list_organization_memberships
+      url: /reference/user-management/organization-membership/list
+      title: usermanagement.ListOrganizationMemberships()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.ListOrganizationMembershipsOpts
+          unwrap: true
+          properties:
+            - key: UserId
+              type: string
+              optional: true
+              description: (organization_membership.user_id)
+            - key: OrganizationID
+              type: string
+              optional: true
+              description: (organization_membership.organization_id)
+            - key: Statuses
+              optional: true
+              type: '[]OrganizationMembershipStatus'
+              description: Filter by the status of the organization membership.
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+      returns:
+        - key: organizationMemberships
+          type: ListOrganizationMembershipsResponse
+          unwrap: true
+          properties:
+            - key: Data
+              type: 'OrganizationMembership[]'
+              description: (list_organization_memberships.data)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (Before)
+                - (After)
+        - (err)
+  php:
+    - key: list_organization_memberships
+      id: list_organization_memberships
+      url: /reference/user-management/organization-membership/list
+      title: $userManagement->listOrganizationMemberships()
+      type: GET
+      parameters:
+        - key: userId
+          optional: true
+          type: string
+          description: (organization_membership.user_id)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (organization_membership.organization_id)
+        - key: statuses
+          optional: true
+          type: 'string[]'
+          description: >-
+            Filter by the status of the organization membership. Array including
+            any of `active`, `inactive`, or `pending`.
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - (before)
+            - (after)
+            - key: data
+              type: 'OrganizationMembership[]'
+              description: (list_organization_memberships.data)
+  python:
+    - key: list_organization_memberships
+      id: list_organization_memberships
+      url: /reference/user-management/organization-membership/list
+      title: user_management.list_organization_memberships()
+      parameters:
+        - key: user_id
+          optional: true
+          type: str
+          description: (organization_membership.user_id)
+        - key: organization_id
+          optional: true
+          type: str
+          description: (organization_membership.organization_id)
+        - key: statuses
+          optional: true
+          type: 'Set[OrganizationMembershipStatus]'
+          description: >-
+            Filter by the status of the organization membership. List including
+            any of `active`, `inactive`, or `pending`.
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[OrganizationMembership]'
+              description: (list_organization_memberships.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+  ruby:
+    - key: list_organization_memberships
+      id: list_organization_memberships
+      url: /reference/user-management/user/list
+      title: UserManagement.list_organization_memberships()
+      parameters:
+        - key: user_id
+          optional: true
+          type: String
+          description: (organization_membership.user_id)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (organization_membership.organization_id)
+        - key: statuses
+          optional: true
+          type: 'Array[String]'
+          description: >-
+            Filter by the status of the organization membership. Array including
+            any of `active`, `inactive`, or `pending`.
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[OrganizationMembership]'
+              description: (list_organization_memberships.data)
+            - key: list_metadata
+              type: Hash
+              properties:
+                - (before)
+                - (after)
+  java:
+    - key: listOrganizationMemberships
+      id: list_organization_memberships
+      url: /reference/user-management/user/list
+      title: userManagement.listOrganizationMemberships()
+      parameters:
+        - key: options
+          type: ListOrganizationMembershipsOptions
+          optional: true
+          unwrap: true
+          properties:
+            - key: userId
+              optional: true
+              type: String
+              description: (organization_membership.user_id)
+            - key: organizationId
+              optional: true
+              type: String
+              description: (organization_membership.organization_id)
+            - key: statuses
+              optional: true
+              type: List<OrganizationMembershipStatusEnumType>
+              description: Filter by the status of the organization membership.
+            - (after)
+            - (before)
+            - (limit)
+            - (order)
+      returns:
+        - key: anonymous
+          type: OrganizationMemberships
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[OrganizationMembership]'
+              description: (list_organization_memberships.data)
+            - key: listMetadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/list.mdx
+---
+
+## List organization memberships
+
+Get a list of all organization memberships matching the criteria specified. At least one of `user_id` or `organization_id` must be provided. By default only active memberships are returned. Use the `statuses` parameter to filter by other statuses.
+
+<CodeBlock referenceId="list_organization_memberships">
+  <CodeBlockTab title="Request" file="list-organization-memberships-request" />
+  <CodeBlockTab
+    title="Response"
+    file="list-organization-memberships-response"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/organization-membership/reactivate.mdx

@@ -0,0 +1,106 @@
+---
+reference:
+  curl:
+    - key: reactivate_organization_membership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: '/user_management/organization_memberships/:id/reactivate'
+      type: PUT
+      parameters:
+        - (organization_membership.id)
+      returns:
+        - (organization_membership)
+  js:
+    - key: reactivateOrganizationMembership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: userManagement.reactivateOrganizationMembership()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (OrganizationMembership.id)
+      returns:
+        - (OrganizationMembership)
+  go:
+    - key: ReactivateOrganizationMembership
+      patternBefore: usermanagement.
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: usermanagement.ReactivateOrganizationMembership()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.ReactivateOrganizationMembershipOpts
+          unwrap: true
+          properties:
+            - key: OrganizationMembership
+              type: string
+              description: (organization_membership.id)
+      returns:
+        - key: organizationMembership
+          type: usermanagement.OrganizationMembership
+          description: (organization_membership.self)
+        - (err)
+  php:
+    - key: reactivateOrganizationMembership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: $userManagement->reactivateOrganizationMembership()
+      parameters:
+        - (OrganizationMembership.id)
+      returns:
+        - (OrganizationMembership)
+  python:
+    - key: reactivate_organization_membership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: user_management.reactivate_organization_membership()
+      parameters:
+        - key: organization_membership_id
+          type: str
+          description: (organization_membership.id)
+      returns:
+        - (OrganizationMembership)
+  ruby:
+    - key: reactivate_organization_membership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: UserManagement.reactivate_organization_membership()
+      parameters:
+        - (OrganizationMembership.id)
+      returns:
+        - (OrganizationMembership)
+  java:
+    - key: reactivateOrganizationMembership
+      id: reactivate_organization_membership
+      url: /reference/user-management/organization-membership/reactivate
+      title: userManagement.reactivateOrganizationMembership()
+      parameters:
+        - (OrganizationMembership.id)
+      returns:
+        - (OrganizationMembership)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/reactivate.mdx
+---
+
+## Reactivate an organization membership
+
+Reactivates an `inactive` organization membership, retaining the pre-existing role. Emits an [organization_membership.updated](/events/organization-membership) event upon successful reactivation.
+
+- Reactivating an `active` membership is a no-op and does not emit an event.
+- Reactivating a `pending` membership returns an error. The user needs to [accept the invitation](/user-management/invitations) instead.
+
+See the [membership management documentation](/user-management/users-organizations/organizations/membership-management) for additional details.
+
+<CodeBlock referenceId="reactivate_organization_membership">
+  <CodeBlockTab
+    title="Request"
+    file="reactivate-organization-membership-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="reactivate-organization-membership-response"
+  />
+</CodeBlock>