@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/fga/resource/update.mdx

@@ -1,113 +1,57 @@
 ---
+descriptions:
+  update_resource:
+    resource_id: The ID of the resource to update (path parameter).
+    name: The new name for the resource.
+    description: The new description for the resource. Pass null to remove the description.
 reference:
   curl:
     - key: update_resource
       id: update_resource
-      url: /reference/fga/resources/update
-      title: '/fga/v1/resources/:resource_type/:resource_id'
-      type: PUT
+      url: /reference/fga/resource/update
+      title: '/authorization/resources/:resource_id'
+      type: PATCH
       parameters:
-        - (resource.resource_type)
-        - (resource.resource_id)
-        - (resource.meta)
+        - key: name
+          type: string
+          optional: true
+          description: (update_resource.name)
+        - key: description
+          type: string | null
+          optional: true
+          description: (update_resource.description)
       returns:
         - (resource)
   js:
     - key: updateResource
       id: update_resource
-      url: /reference/fga/resources/update
-      title: fga.updateResource()
-      type: PUT
+      url: /reference/fga/resource/update
+      title: authorization.updateResource()
       parameters:
         - key: options
           type: object
           unwrap: true
           properties:
-            - key: resource
-              type: object
-              properties:
-                - key: resourceType
-                  type: string
-                  description: (resource.resource_type)
-                - key: resourceId
-                  type: string
-                  description: (resource.resource_id)
-            - key: meta
-              type: string
-              description: (resource.meta)
-      returns:
-        - (Resource)
-  go:
-    - key: UpdateResource
-      id: update_resource
-      url: /reference/fga/resources/update
-      title: fga.UpdateResource()
-      type: PUT
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.UpdateResourceOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
-              type: string
-              description: (resource.resource_type)
-            - key: ResourceId
+            - key: resourceId
               type: string
-              description: (resource.resource_id)
-            - key: Meta
+              description: (update_resource.resource_id)
+            - key: name
               type: string
-              description: (resource.meta)
+              optional: true
+              description: (update_resource.name)
+            - key: description
+              type: string | null
+              optional: true
+              description: (update_resource.description)
       returns:
-        - key: resource
-          type: fga.Resource
+        - key: AuthorizationResource
           description: (resource.self)
-        - (err)
-  java:
-    - key: updateResource
-      id: update_resource
-      url: /reference/fga/resources/update
-      title: fga.updateResource()
-      type: PUT
-      parameters:
-        - key: resourceType
-          type: String
-          description: (resource.resource_type)
-        - key: resourceId
-          type: String
-          description: (resource.resource_id)
-        - key: options
-          type: UpdateResourceOptions
-          properties:
-            - key: meta
-              type: String
-              description: (resource.meta)
-      returns:
-        - (Resource)
-  python:
-    - key: update_resource
-      id: update_resource
-      url: /reference/fga/resources/update
-      title: fga.update_resource()
-      type: PUT
-      parameters:
-        - key: resource_type
-          type: string
-          description: (resource.resource_type)
-        - key: resource_id
-          type: string
-          description: (resource.resource_id)
-        - key: meta
-          type: dict
-          description: (resource.meta)
-      returns:
-        - (Resource)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/update.mdx
 ---
 
 ## Update a resource
 
-Update the meta of an existing resource in the current environment.
+Update an existing authorization resource. Only the fields provided will be updated.
 
 <CodeBlock referenceId="update_resource">
   <CodeBlockTab title="Request" file="update-resource-request" />

package/.docs/organized/docs/reference/fga/role-assignment/create.mdx

@@ -0,0 +1,89 @@
+---
+descriptions:
+  assign_role:
+    organization_membership_id: The ID of the organization membership.
+    role_slug: The slug of the role to assign.
+    resource_id: >-
+      The ID of the resource to assign the role on. Use either this or
+      resource_external_id + resource_type_slug.
+    resource_external_id: The external ID of the resource. Requires resource_type_slug.
+    resource_type_slug: The resource type slug. Required with resource_external_id.
+reference:
+  curl:
+    - key: assign_role
+      id: assign_role
+      url: /reference/fga/role-assignment/create
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/role_assignments
+      type: POST
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (assign_role.organization_membership_id)
+        - key: role_slug
+          type: string
+          description: (assign_role.role_slug)
+        - key: resource_id
+          type: string
+          optional: true
+          description: (assign_role.resource_id)
+        - key: resource_external_id
+          type: string
+          optional: true
+          description: (assign_role.resource_external_id)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (assign_role.resource_type_slug)
+      returns:
+        - (role_assignment)
+  js:
+    - key: assignRole
+      id: assign_role
+      url: /reference/fga/role-assignment/create
+      title: authorization.assignRole()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (assign_role.organization_membership_id)
+            - key: roleSlug
+              type: string
+              description: (assign_role.role_slug)
+            - key: resourceId
+              type: string
+              optional: true
+              description: (assign_role.resource_id)
+            - key: resourceExternalId
+              type: string
+              optional: true
+              description: (assign_role.resource_external_id)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (assign_role.resource_type_slug)
+      returns:
+        - key: RoleAssignment
+          description: (role_assignment.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/role-assignment/create.mdx
+---
+
+## Assign a role
+
+Assign a role to an organization membership on a specific resource. The user will immediately gain all permissions included in that role on the resource and its descendants.
+
+You must provide either `resource_id` or both `resource_external_id` and `resource_type_slug` to identify the resource.
+
+<Callout type="info">
+  The role must be scoped to the resource type of the target resource. You
+  cannot assign a project role on a workspace resource.
+</Callout>
+
+<CodeBlock referenceId="assign_role">
+  <CodeBlockTab title="Request" file="assign-role-request" />
+  <CodeBlockTab title="Response" file="assign-role-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/role-assignment/delete-by-id.mdx

@@ -0,0 +1,59 @@
+---
+descriptions:
+  remove_role_by_id:
+    organization_membership_id: The ID of the organization membership.
+    role_assignment_id: The ID of the role assignment to remove.
+reference:
+  curl:
+    - key: remove_role_by_id
+      id: remove_role_by_id
+      url: /reference/fga/role-assignment/delete-by-id
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/role_assignments/:role_assignment_id
+      type: DELETE
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (remove_role_by_id.organization_membership_id)
+        - key: role_assignment_id
+          type: string
+          description: (remove_role_by_id.role_assignment_id)
+      returns:
+        - key: empty
+          type: empty
+          description: Returns an empty response on success.
+  js:
+    - key: removeRoleAssignment
+      id: remove_role_by_id
+      url: /reference/fga/role-assignment/delete-by-id
+      title: authorization.removeRoleAssignment()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (remove_role_by_id.organization_membership_id)
+            - key: roleAssignmentId
+              type: string
+              description: (remove_role_by_id.role_assignment_id)
+      returns:
+        - key: void
+          description: Returns nothing on success.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/role-assignment/delete-by-id.mdx
+---
+
+## Remove a role assignment by ID
+
+Remove a role assignment using its ID. Access is revoked immediately. Removing an assignment also removes any permissions that were inherited by child resources through that assignment.
+
+<Callout type="warning">
+  This removes the specific role assignment, but direct assignments on child
+  resources remain intact.
+</Callout>
+
+<CodeBlock referenceId="remove_role_by_id">
+  <CodeBlockTab title="Request" file="remove-role-by-id-request" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/role-assignment/delete.mdx

@@ -0,0 +1,90 @@
+---
+descriptions:
+  remove_role_by_criteria:
+    organization_membership_id: The ID of the organization membership.
+    role_slug: The slug of the role to remove.
+    resource_id: >-
+      The ID of the resource. Use either this or resource_external_id +
+      resource_type_slug.
+    resource_external_id: The external ID of the resource. Requires resource_type_slug.
+    resource_type_slug: The resource type slug. Required with resource_external_id.
+reference:
+  curl:
+    - key: remove_role_by_criteria
+      id: remove_role_by_criteria
+      url: /reference/fga/role-assignment/delete
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/role_assignments
+      type: DELETE
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (remove_role_by_criteria.organization_membership_id)
+        - key: role_slug
+          type: string
+          description: (remove_role_by_criteria.role_slug)
+        - key: resource_id
+          type: string
+          optional: true
+          description: (remove_role_by_criteria.resource_id)
+        - key: resource_external_id
+          type: string
+          optional: true
+          description: (remove_role_by_criteria.resource_external_id)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (remove_role_by_criteria.resource_type_slug)
+      returns:
+        - key: empty
+          type: empty
+          description: Returns an empty response on success.
+  js:
+    - key: removeRole
+      id: remove_role_by_criteria
+      url: /reference/fga/role-assignment/delete
+      title: authorization.removeRole()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (remove_role_by_criteria.organization_membership_id)
+            - key: roleSlug
+              type: string
+              description: (remove_role_by_criteria.role_slug)
+            - key: resourceId
+              type: string
+              optional: true
+              description: (remove_role_by_criteria.resource_id)
+            - key: resourceExternalId
+              type: string
+              optional: true
+              description: (remove_role_by_criteria.resource_external_id)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (remove_role_by_criteria.resource_type_slug)
+      returns:
+        - key: void
+          description: Returns nothing on success.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/role-assignment/delete.mdx
+---
+
+## Remove a role assignment
+
+Remove a role assignment by specifying the role slug and resource. Access is revoked immediately. Removing an assignment also removes any permissions that were inherited by child resources through that assignment.
+
+You must provide either `resource_id` or both `resource_external_id` and `resource_type_slug` to identify the resource.
+
+<Callout type="warning">
+  This removes the specific role assignment, but direct assignments on child
+  resources remain intact.
+</Callout>
+
+<CodeBlock referenceId="remove_role_by_criteria">
+  <CodeBlockTab title="Request" file="remove-role-by-criteria-request" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/role-assignment/index.mdx

@@ -0,0 +1,106 @@
+---
+descriptions:
+  role_assignment:
+    self: >-
+      The Role Assignment object represents a binding between an organization
+      membership and a role on a specific resource.
+    object: Distinguishes the Role Assignment object.
+    id: Unique identifier of the role assignment.
+    role: The role that was assigned.
+    role_slug: The slug of the assigned role.
+    resource: The resource the role is assigned on.
+    resource_id: The ID of the resource.
+    resource_external_id: The external ID of the resource.
+    resource_type_slug: The slug of the resource type.
+    created_at: The timestamp when the role assignment was created.
+    updated_at: The timestamp when the role assignment was last updated.
+reference:
+  curl:
+    - url: /reference/fga/role-assignment
+      key: role_assignment
+      id: role_assignment
+      title: Role Assignment
+      properties:
+        - key: object
+          type: '"role_assignment"'
+          description: (role_assignment.object)
+        - key: id
+          type: string
+          description: (role_assignment.id)
+        - key: role
+          type: object
+          description: (role_assignment.role)
+          properties:
+            - key: slug
+              type: string
+              description: (role_assignment.role_slug)
+        - key: resource
+          type: object
+          description: (role_assignment.resource)
+          properties:
+            - key: id
+              type: string
+              description: (role_assignment.resource_id)
+            - key: external_id
+              type: string
+              description: (role_assignment.resource_external_id)
+            - key: resource_type_slug
+              type: string
+              description: (role_assignment.resource_type_slug)
+        - key: created_at
+          type: string
+          description: (role_assignment.created_at)
+        - key: updated_at
+          type: string
+          description: (role_assignment.updated_at)
+  js:
+    - url: /reference/fga/role-assignment
+      key: RoleAssignment
+      id: role_assignment
+      title: RoleAssignment
+      properties:
+        - key: object
+          type: '"role_assignment"'
+          description: (role_assignment.object)
+        - key: id
+          type: string
+          description: (role_assignment.id)
+        - key: role
+          type: object
+          description: (role_assignment.role)
+          properties:
+            - key: slug
+              type: string
+              description: (role_assignment.role_slug)
+        - key: resource
+          type: object
+          description: (role_assignment.resource)
+          properties:
+            - key: id
+              type: string
+              description: (role_assignment.resource_id)
+            - key: externalId
+              type: string
+              description: (role_assignment.resource_external_id)
+            - key: resourceTypeSlug
+              type: string
+              description: (role_assignment.resource_type_slug)
+        - key: createdAt
+          type: string
+          description: (role_assignment.created_at)
+        - key: updatedAt
+          type: string
+          description: (role_assignment.updated_at)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/role-assignment/index.mdx
+---
+
+# Role Assignment
+
+A role assignment connects an organization membership to a role on a specific resource. When a role is assigned, the user gains all permissions included in that role on the resource and its descendants through permission inheritance.
+
+<CodeBlock
+  title="Role Assignment"
+  file="role-assignment"
+  referenceId="role_assignment"
+/>

package/.docs/organized/docs/reference/fga/role-assignment/list.mdx

@@ -0,0 +1,86 @@
+---
+descriptions:
+  list_role_assignments:
+    organization_membership_id: The ID of the organization membership.
+    limit: 'Maximum number of records to return (default 10, max 100).'
+    before: Cursor for pagination (before).
+    after: Cursor for pagination (after).
+    order: Sort order (asc or desc).
+    data: 'Array of [Role Assignment](/reference/fga/role-assignment) objects.'
+reference:
+  curl:
+    - key: list_role_assignments
+      id: list_role_assignments
+      url: /reference/fga/role-assignment/list
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/role_assignments
+      type: GET
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (list_role_assignments.organization_membership_id)
+        - key: limit
+          type: number
+          optional: true
+          description: (list_role_assignments.limit)
+        - key: before
+          type: string
+          optional: true
+          description: (list_role_assignments.before)
+        - key: after
+          type: string
+          optional: true
+          description: (list_role_assignments.after)
+        - key: order
+          type: '"asc" | "desc"'
+          optional: true
+          description: (list_role_assignments.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_role_assignments.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - key: before
+                  type: string | null
+                - key: after
+                  type: string | null
+  js:
+    - key: listRoleAssignments
+      id: list_role_assignments
+      url: /reference/fga/role-assignment/list
+      title: authorization.listRoleAssignments()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (list_role_assignments.organization_membership_id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'RoleAssignment[]'
+              description: (list_role_assignments.data)
+            - key: listMetadata
+              type: ListMetadata
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/role-assignment/list.mdx
+---
+
+## List role assignments
+
+List all role assignments for an organization membership. This returns all roles that have been assigned to the user on resources, including organization-level and sub-resource roles.
+
+<CodeBlock referenceId="list_role_assignments">
+  <CodeBlockTab title="Request" file="list-role-assignments-request" />
+  <CodeBlockTab title="Response" file="list-role-assignments-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/index.mdx

@@ -43,7 +43,7 @@ reference:
       description: (dotnet.task)
   js:
     - url: >-
-        https://github.com/workos/authkit-nextjs/blob/main/src/authkit-callback-route.ts
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#callback-route
       key: handleAuth
       id: handleAuth
       title: handleAuth()
@@ -65,7 +65,8 @@ reference:
       returns:
         - key: anonymous
           type: Function
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+    - url: >-
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#get-the-current-user-in-a-server-component
       key: getSignInUrl
       id: getSignInUrl
       title: getSignInUrl()
@@ -74,7 +75,8 @@ reference:
       returns:
         - key: anonymous
           type: Promise<string>
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+    - url: >-
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#get-the-current-user-in-a-server-component
       key: getSignUpUrl
       id: getSignUpUrl
       title: getSignUpUrl()
@@ -83,7 +85,7 @@ reference:
       returns:
         - key: anonymous
           type: Promise<string>
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+    - url: 'https://github.com/workos/authkit-nextjs?tab=readme-ov-file#signing-out'
       key: signOut
       id: signOut
       title: signOut()
@@ -92,7 +94,8 @@ reference:
       returns:
         - key: anonymous
           type: Promise<void>
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/session.ts'
+    - url: >-
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#get-the-current-user-in-a-server-component
       key: withAuth
       id: withAuth
       title: withAuth()
@@ -109,7 +112,7 @@ reference:
         - key: anonymous
           type: Promise<UserInfo | NoUserInfo>
     - url: >-
-        https://github.com/workos/authkit-nextjs/blob/main/src/components/authkit-provider.ts
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#get-the-current-user-in-a-client-component
       key: useAuth
       id: useAuth
       title: useAuth()
@@ -125,7 +128,8 @@ reference:
       returns:
         - key: anonymous
           type: Promise<UserInfo | NoUserInfo>
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/middleware.ts'
+    - url: >-
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#middleware-auth
       key: authkitMiddleware
       id: authkitMiddleware
       title: authkitMiddleware()
@@ -150,7 +154,8 @@ reference:
       returns:
         - key: anonymous
           type: NextMiddleware
-    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/middleware.ts'
+    - url: >-
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#session-refresh-callbacks
       key: authkit
       id: authkit
       title: authkit()
@@ -169,7 +174,7 @@ reference:
         - key: anonymous
           type: Promise<AuthKitResponse>
     - url: >-
-        https://github.com/workos/authkit-nextjs/blob/main/src/components/authkit-provider.tsx
+        https://github.com/workos/authkit-nextjs?tab=readme-ov-file#wrap-your-app-in-authkitprovider
       key: AuthKitProvider
       id: AuthKitProvider
       title: AuthKitProvider
@@ -183,12 +188,16 @@ reference:
 originalPath: .tmp-workos-clone/packages/docs/content/reference/index.mdx
 ---
 
-# API reference
+# Getting started
+
+The WorkOS API gives you everything you need to make your app enterprise-ready. Authenticate users, sync directories, enforce access controls, stream audit logs, and more -- all through a single integration.
 
-The WorkOS API enables adding Enterprise Ready features to your application. This REST API provides programmatic access to User Management, Single Sign-On, Directory Sync, and Audit Log resources.
+The API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
 
 [Sign in](https://dashboard.workos.com/) to see code examples customized with your API keys and data.
 
 ```url title="API Base URL"
-https://api.workos.com
+https://api_workos_com
 ```
+
+**Not a developer?** You can explore most of WorkOS without writing any code. The [WorkOS Dashboard](https://dashboard.workos.com/) lets you configure SSO connections, manage directories, set up audit log streams, and more -- all from a visual interface.

package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx

@@ -192,7 +192,7 @@ originalPath: >-
   .tmp-workos-clone/packages/docs/content/reference/magic-link/passwordless-session/index.mdx
 ---
 
-## Passwordless Session [Deprecated]
+# Passwordless Session [Deprecated]
 
 An object representing a passwordless authentication session.