@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/fga/access-check/list-resources.mdx

@@ -0,0 +1,152 @@
+---
+descriptions:
+  list_resources_for_membership:
+    organization_membership_id: The ID of the organization membership.
+    permission_slug: >-
+      The permission slug to filter by. Only resources where the user has this
+      permission are returned.
+    parent_resource_id: >-
+      The ID of the parent resource. Use either this or
+      parent_resource_external_id + parent_resource_type_slug.
+    parent_resource_external_id: >-
+      The external ID of the parent resource. Requires
+      parent_resource_type_slug.
+    parent_resource_type_slug: >-
+      The resource type slug of the parent. Required with
+      parent_resource_external_id.
+    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 [Resource](/reference/fga/resource) objects where the user has
+      the permission.
+reference:
+  curl:
+    - key: list_resources_for_membership
+      id: list_resources_for_membership
+      url: /reference/fga/access-check/list-resources
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/resources
+      type: GET
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (list_resources_for_membership.organization_membership_id)
+        - key: permission_slug
+          type: string
+          description: (list_resources_for_membership.permission_slug)
+        - key: parent_resource_id
+          type: string
+          optional: true
+          description: (list_resources_for_membership.parent_resource_id)
+        - key: parent_resource_external_id
+          type: string
+          optional: true
+          description: (list_resources_for_membership.parent_resource_external_id)
+        - key: parent_resource_type_slug
+          type: string
+          optional: true
+          description: (list_resources_for_membership.parent_resource_type_slug)
+        - key: limit
+          type: number
+          optional: true
+          description: (list_resources_for_membership.limit)
+        - key: before
+          type: string
+          optional: true
+          description: (list_resources_for_membership.before)
+        - key: after
+          type: string
+          optional: true
+          description: (list_resources_for_membership.after)
+        - key: order
+          type: '"asc" | "desc"'
+          optional: true
+          description: (list_resources_for_membership.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_resources_for_membership.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - key: before
+                  type: string | null
+                - key: after
+                  type: string | null
+  js:
+    - key: listResourcesForMembership
+      id: list_resources_for_membership
+      url: /reference/fga/access-check/list-resources
+      title: authorization.listResourcesForMembership()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (list_resources_for_membership.organization_membership_id)
+            - key: permissionSlug
+              type: string
+              description: (list_resources_for_membership.permission_slug)
+            - key: parentResourceId
+              type: string
+              optional: true
+              description: (list_resources_for_membership.parent_resource_id)
+            - key: parentResourceTypeSlug
+              type: string
+              optional: true
+              description: (list_resources_for_membership.parent_resource_type_slug)
+            - key: parentResourceExternalId
+              type: string
+              optional: true
+              description: (list_resources_for_membership.parent_resource_external_id)
+            - key: limit
+              type: number
+              optional: true
+              description: (list_resources_for_membership.limit)
+            - key: before
+              type: string
+              optional: true
+              description: (list_resources_for_membership.before)
+            - key: after
+              type: string
+              optional: true
+              description: (list_resources_for_membership.after)
+            - key: order
+              type: '"asc" | "desc"'
+              optional: true
+              description: (list_resources_for_membership.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'AuthorizationResource[]'
+              description: (list_resources_for_membership.data)
+            - key: listMetadata
+              type: ListMetadata
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/access-check/list-resources.mdx
+---
+
+## List resources for an organization membership
+
+Returns all child resources of a parent resource where the organization membership has a specific permission. This is useful for resource discovery—answering "What projects can this user access in this workspace?"
+
+You must provide either `parent_resource_id` or both `parent_resource_external_id` and `parent_resource_type_slug` to identify the parent resource.
+
+<CodeBlock referenceId="list_resources_for_membership">
+  <CodeBlockTab title="Request" file="list-resources-for-membership-request" />
+  <CodeBlockTab
+    title="Response"
+    file="list-resources-for-membership-response"
+  />
+</CodeBlock>

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

@@ -1,6 +1,18 @@
 ---
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/index.mdx
 ---
-# Fine-Grained Authorization
+# FGA (Fine-Grained Authorization)
 
-Fine-Grained Authorization (FGA) is a set of APIs designed to help you implement scalable, centralized, fine grained authorization in your application.
+The FGA API provides endpoints for managing fine-grained authorization in your WorkOS environment. Use these endpoints to create resources, assign roles, and check access permissions for your users.
+
+## Resources
+
+Resources are instances of resource types that represent entities in your application—workspaces, projects, apps, or any other object that users can access. Resources form a hierarchy where permissions can be inherited from parent to child.
+
+## Role Assignments
+
+Role assignments connect organization memberships to roles on specific resources. When a role is assigned to a user on a resource, they gain all permissions included in that role on that resource and its descendants.
+
+## Access Checks
+
+Access check endpoints let you determine whether a user has a specific permission on a resource. You can also discover which resources a user can access, or which users have access to a specific resource.

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

@@ -1,128 +1,114 @@
 ---
 descriptions:
   create_resource:
-    resource_id: >-
-      Unique string ID of the resource. If one is not provided, one will be
-      automatically generated upon creation.
+    external_id: >-
+      An identifier you provide to reference the resource in your system. Must
+      be unique within the organization and resource type.
+    name: A human-readable name for the resource.
+    description: An optional description for the resource.
+    resource_type_slug: The slug of the resource type this resource belongs to.
+    organization_id: The ID of the organization this resource belongs to.
+    parent_resource_id: >-
+      The ID of the parent resource. Use either this or
+      parent_resource_external_id + parent_resource_type_slug.
+    parent_resource_external_id: >-
+      The external ID of the parent resource. Requires
+      parent_resource_type_slug.
+    parent_resource_type_slug: >-
+      The resource type slug of the parent resource. Required with
+      parent_resource_external_id.
 reference:
   curl:
     - key: create_resource
       id: create_resource
-      url: /reference/fga/resources/create
-      title: /fga/v1/resources
+      url: /reference/fga/resource/create
+      title: /authorization/resources
       type: POST
       parameters:
-        - key: resource_type
+        - key: external_id
           type: string
-          description: (resource.resource_type)
-        - key: resource_id
+          description: (create_resource.external_id)
+        - key: name
+          type: string
+          description: (create_resource.name)
+        - key: description
           type: string
           optional: true
-          description: (create_resource.resource_id)
-        - key: meta
-          type: object
+          description: (create_resource.description)
+        - key: resource_type_slug
+          type: string
+          description: (create_resource.resource_type_slug)
+        - key: organization_id
+          type: string
+          description: (create_resource.organization_id)
+        - key: parent_resource_id
+          type: string
           optional: true
-          description: (resource.meta)
+          description: (create_resource.parent_resource_id)
+        - key: parent_resource_external_id
+          type: string
+          optional: true
+          description: (create_resource.parent_resource_external_id)
+        - key: parent_resource_type_slug
+          type: string
+          optional: true
+          description: (create_resource.parent_resource_type_slug)
       returns:
         - (resource)
   js:
     - key: createResource
       id: create_resource
-      url: /reference/fga/resources/create
-      title: fga.createResource()
+      url: /reference/fga/resource/create
+      title: authorization.createResource()
       parameters:
         - key: options
           type: object
           unwrap: true
           properties:
-            - key: resourceType
+            - key: organizationId
               type: string
-              description: (resource.resource_type)
-            - key: resourceId
+              description: (create_resource.organization_id)
+            - key: resourceTypeSlug
               type: string
-              optional: true
-              description: (create_resource.resource_id)
-            - key: meta
-              type: object
-              optional: true
-              description: (resource.meta)
-      returns:
-        - (Resource)
-  go:
-    - key: CreateResource
-      id: create_resource
-      url: /reference/fga/resources/create
-      title: fga.CreateResource()
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.CreateResourceOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
+              description: (create_resource.resource_type_slug)
+            - key: externalId
+              type: string
+              description: (create_resource.external_id)
+            - key: name
               type: string
-              description: (resource.resource_type)
-            - key: ResourceId
+              description: (create_resource.name)
+            - key: description
               type: string
               optional: true
-              description: (create_resource.resource_id)
-            - key: Meta
-              type: object
+              description: (create_resource.description)
+            - key: parentResourceId
+              type: string
               optional: true
-              description: (resource.meta)
-      returns:
-        - key: resource
-          type: fga.Resource
-          description: (resource.self)
-        - (err)
-  java:
-    - key: createResource
-      id: create_resource
-      url: /reference/fga/resources/create
-      title: fga.createResource()
-      parameters:
-        - key: options
-          type: CreateResourceOptions
-          unwrap: true
-          properties:
-            - key: resourceType
-              type: String
-              description: (resource.resource_type)
-            - key: resourceId
-              type: String
+              description: (create_resource.parent_resource_id)
+            - key: parentResourceExternalId
+              type: string
               optional: true
-              description: (create_resource.resource_id)
-            - key: meta
-              type: 'Map<String, String>'
+              description: (create_resource.parent_resource_external_id)
+            - key: parentResourceTypeSlug
+              type: string
               optional: true
-              description: (resource.meta)
+              description: (create_resource.parent_resource_type_slug)
       returns:
-        - (Resource)
-  python:
-    - key: create_resource
-      id: create_resource
-      url: /reference/fga/resources/create
-      title: fga.create_resource()
-      parameters:
-        - key: resource_type
-          type: str
-          description: (resource.resource_type)
-        - key: resource_id
-          type: str
-          optional: true
-          description: (create_resource.resource_id)
-        - key: meta
-          type: dict
-          optional: true
-          description: (resource.meta)
-      returns:
-        - (Resource)
+        - key: AuthorizationResource
+          description: (resource.self)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/create.mdx
 ---
 
 ## Create a resource
 
-Create a new resource in the current environment.
+Create a new authorization resource. The resource is associated with an organization and resource type.
+
+You can optionally specify a parent resource to place it in a hierarchy. The parent can be identified either by `parent_resource_id` or by the combination of `parent_resource_external_id` and `parent_resource_type_slug`.
+
+<Callout type="info">
+  The `external_id` must be unique within the organization and resource type
+  combination.
+</Callout>
 
 <CodeBlock referenceId="create_resource">
   <CodeBlockTab title="Request" file="create-resource-request" />

package/.docs/organized/docs/reference/fga/resource/delete-by-external-id.mdx

@@ -0,0 +1,78 @@
+---
+descriptions:
+  delete_resource_by_external_id:
+    organization_id: The ID of the organization.
+    resource_type_slug: The slug of the resource type.
+    external_id: The external ID of the resource.
+    cascade_delete: >-
+      If true, deletes all descendant resources and role assignments. Defaults
+      to false. If not set and the resource has children or assignments, the
+      request will fail.
+reference:
+  curl:
+    - key: delete_resource_by_external_id
+      id: delete_resource_by_external_id
+      url: /reference/fga/resource/delete-by-external-id
+      title: >-
+        /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id
+      type: DELETE
+      parameters:
+        - key: organization_id
+          type: string
+          description: (delete_resource_by_external_id.organization_id)
+        - key: resource_type_slug
+          type: string
+          description: (delete_resource_by_external_id.resource_type_slug)
+        - key: external_id
+          type: string
+          description: (delete_resource_by_external_id.external_id)
+        - key: cascade_delete
+          type: boolean
+          optional: true
+          description: (delete_resource_by_external_id.cascade_delete)
+      returns:
+        - key: empty
+          type: empty
+          description: Returns an empty response on success.
+  js:
+    - key: deleteResourceByExternalId
+      id: delete_resource_by_external_id
+      url: /reference/fga/resource/delete-by-external-id
+      title: authorization.deleteResourceByExternalId()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (delete_resource_by_external_id.organization_id)
+            - key: resourceTypeSlug
+              type: string
+              description: (delete_resource_by_external_id.resource_type_slug)
+            - key: externalId
+              type: string
+              description: (delete_resource_by_external_id.external_id)
+            - key: cascadeDelete
+              type: boolean
+              optional: true
+              description: (delete_resource_by_external_id.cascade_delete)
+      returns:
+        - key: void
+          description: Returns nothing on success.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/resource/delete-by-external-id.mdx
+---
+
+## Delete a resource by external ID
+
+Delete an authorization resource using its external ID. By default, this will fail if the resource has child resources or role assignments. Set `cascade_delete` to `true` to delete the resource along with all its descendants and role assignments.
+
+<Callout type="warning">
+  Deleting a resource also removes all role assignments on that resource. This
+  action cannot be undone.
+</Callout>
+
+<CodeBlock referenceId="delete_resource_by_external_id">
+  <CodeBlockTab title="Request" file="delete-resource-by-external-id-request" />
+</CodeBlock>

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

@@ -1,86 +1,62 @@
 ---
+descriptions:
+  delete_resource:
+    resource_id: The ID of the resource to delete.
+    cascade_delete: >-
+      If true, deletes all descendant resources and role assignments. Defaults
+      to false. If not set and the resource has children or assignments, the
+      request will fail.
 reference:
   curl:
     - key: delete_resource
       id: delete_resource
-      url: /reference/fga/resources/delete
-      title: '/fga/v1/resources/:resource_type/:resource_id'
+      url: /reference/fga/resource/delete
+      title: '/authorization/resources/:resource_id'
       type: DELETE
       parameters:
-        - (resource.resource_type)
-        - (resource.resource_id)
+        - key: resource_id
+          type: string
+          description: (delete_resource.resource_id)
+        - key: cascade_delete
+          type: boolean
+          optional: true
+          description: (delete_resource.cascade_delete)
+      returns:
+        - key: empty
+          type: empty
+          description: Returns an empty response on success.
   js:
     - key: deleteResource
       id: delete_resource
-      url: /reference/fga/resources/delete
-      title: fga.deleteResource()
-      type: DELETE
+      url: /reference/fga/resource/delete
+      title: authorization.deleteResource()
       parameters:
         - key: options
           type: object
           unwrap: true
           properties:
-            - key: resourceType
-              type: string
-              description: (resource.resource_type)
             - key: resourceId
               type: string
-              description: (resource.resource_id)
-  go:
-    - key: DeleteResource
-      id: delete_resource
-      url: /reference/fga/resources/delete
-      title: fga.DeleteResource()
-      type: DELETE
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.DeleteResourceOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
-              type: string
-              description: (resource.resource_type)
-            - key: ResourceId
-              type: string
-              description: (resource.resource_id)
-  java:
-    - key: deleteResource
-      id: delete_resource
-      url: /reference/fga/resources/delete
-      title: fga.deleteResource()
-      type: DELETE
-      parameters:
-        - key: resourceType
-          type: String
-          description: (resource.resource_type)
-        - key: resourceId
-          type: String
-          description: (resource.resource_id)
-  python:
-    - key: delete_resource
-      id: delete_resource
-      url: /reference/fga/resources/delete
-      title: fga.delete_resource()
-      type: DELETE
-      parameters:
-        - key: resource_type
-          type: str
-          description: (resource.resource_type)
-        - key: resource_id
-          type: str
-          description: (resource.resource_id)
+              description: (delete_resource.resource_id)
+            - key: cascadeDelete
+              type: boolean
+              optional: true
+              description: (delete_resource.cascade_delete)
+      returns:
+        - key: void
+          description: Returns nothing on success.
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/delete.mdx
 ---
 
 ## Delete a resource
 
-Deletes a resource in the current environment.
+Delete an authorization resource. By default, this will fail if the resource has child resources or role assignments. Set `cascade_delete` to `true` to delete the resource along with all its descendants and role assignments.
 
-> Deleting a resource will also delete all warrants where the resource is the `resource` or `subject` of the warrant.
+<Callout type="warning">
+  Deleting a resource also removes all role assignments on that resource. This
+  action cannot be undone.
+</Callout>
 
-<CodeBlock
-  title="Request"
-  referenceId="delete_resource"
-  file="delete-resource"
-/>
+<CodeBlock referenceId="delete_resource">
+  <CodeBlockTab title="Request" file="delete-resource-request" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/resource/get-by-external-id.mdx

@@ -0,0 +1,60 @@
+---
+descriptions:
+  get_resource_by_external_id:
+    organization_id: The ID of the organization.
+    resource_type_slug: The slug of the resource type.
+    external_id: The external ID of the resource.
+reference:
+  curl:
+    - key: get_resource_by_external_id
+      id: get_resource_by_external_id
+      url: /reference/fga/resource/get-by-external-id
+      title: >-
+        /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id
+      type: GET
+      parameters:
+        - key: organization_id
+          type: string
+          description: (get_resource_by_external_id.organization_id)
+        - key: resource_type_slug
+          type: string
+          description: (get_resource_by_external_id.resource_type_slug)
+        - key: external_id
+          type: string
+          description: (get_resource_by_external_id.external_id)
+      returns:
+        - (resource)
+  js:
+    - key: getResourceByExternalId
+      id: get_resource_by_external_id
+      url: /reference/fga/resource/get-by-external-id
+      title: authorization.getResourceByExternalId()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (get_resource_by_external_id.organization_id)
+            - key: resourceTypeSlug
+              type: string
+              description: (get_resource_by_external_id.resource_type_slug)
+            - key: externalId
+              type: string
+              description: (get_resource_by_external_id.external_id)
+      returns:
+        - key: AuthorizationResource
+          description: (resource.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/resource/get-by-external-id.mdx
+---
+
+## Get a resource by external ID
+
+Retrieve the details of an authorization resource by its external ID, organization, and resource type. This is useful when you only have the external ID from your system and need to fetch the full resource details.
+
+<CodeBlock referenceId="get_resource_by_external_id">
+  <CodeBlockTab title="Request" file="get-resource-by-external-id-request" />
+  <CodeBlockTab title="Response" file="get-resource-by-external-id-response" />
+</CodeBlock>