@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/feature-flags/targeting/list-for-organization.mdx

@@ -0,0 +1,132 @@
+---
+descriptions:
+  list_organization_feature_flags:
+    data: >-
+      Array of [Feature Flags](/reference/feature-flags) enabled for the
+      organization.
+    organization_id: The ID of the organization to list feature flags for.
+reference:
+  curl:
+    - key: list_organization_feature_flags
+      id: list_organization_feature_flags
+      url: /reference/feature-flags/list-for-organization
+      title: '/organizations/:organization_id/feature-flags'
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_organization_feature_flags.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listOrganizationFeatureFlags
+      id: list_organization_feature_flags
+      url: /reference/feature-flags/list-for-organization
+      title: organizations.listOrganizationFeatureFlags()
+      parameters:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (list_organization_feature_flags.organization_id)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'FeatureFlag[]'
+              description: (list_organization_feature_flags.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  ruby:
+    - key: list_organization_feature_flags
+      id: list_organization_feature_flags
+      url: /reference/feature-flags/list-for-organization
+      title: Organizations.list_organization_feature_flags()
+      parameters:
+        - key: organization_id
+          type: String
+          description: (list_organization_feature_flags.organization_id)
+        - key: options
+          type: Object
+          optional: true
+          properties:
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[FeatureFlag]'
+              description: (list_organization_feature_flags.data)
+            - key: list_metadata
+              type: Struct
+              properties:
+                - (before)
+                - (after)
+  python:
+    - key: list_organization_feature_flags
+      id: list_organization_feature_flags
+      url: /reference/feature-flags/list-for-organization
+      title: organizations.list_feature_flags()
+      parameters:
+        - key: organization_id
+          type: str
+          description: (list_organization_feature_flags.organization_id)
+      returns:
+        - key: anonymous
+          type: FeatureFlagsListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[FeatureFlag]'
+              description: (list_organization_feature_flags.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/targeting/list-for-organization.mdx
+---
+
+## List feature flags for an organization
+
+Get a list of all enabled feature flags for the provided organization.
+
+<CodeBlock referenceId="list_organization_feature_flags">
+  <CodeBlockTab
+    title="Request"
+    file="list-organization-feature-flags-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="list-organization-feature-flags-response"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/feature-flags/targeting/list-for-user.mdx

@@ -0,0 +1,94 @@
+---
+descriptions:
+  list_user_feature_flags:
+    data: 'Array of [Feature Flags](/reference/feature-flags) enabled for the user.'
+    user_id: The ID of the user to list feature flags for.
+reference:
+  curl:
+    - key: list_user_feature_flags
+      id: list_user_feature_flags
+      url: /reference/feature-flags/list-for-user
+      title: '/user_management/users/:id/feature-flags'
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_user_feature_flags.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listUserFeatureFlags
+      id: list_user_feature_flags
+      url: /reference/feature-flags/list-for-user
+      title: userManagement.listUserFeatureFlags()
+      parameters:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: userId
+              type: string
+              description: (list_user_feature_flags.user_id)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'FeatureFlag[]'
+              description: (list_user_feature_flags.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  python:
+    - key: list_user_feature_flags
+      id: list_user_feature_flags
+      url: /reference/feature-flags/list-for-user
+      title: user_management.list_feature_flags()
+      parameters:
+        - key: user_id
+          type: str
+          description: (list_user_feature_flags.user_id)
+      returns:
+        - key: anonymous
+          type: FeatureFlagsListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[FeatureFlag]'
+              description: (list_user_feature_flags.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/feature-flags/targeting/list-for-user.mdx
+---
+
+## List feature flags for a user
+
+Get a list of all enabled feature flags for the provided user. This includes feature flags enabled specifically for the user as well as any organizations that the user is a member of.
+
+<CodeBlock referenceId="list_user_feature_flags">
+  <CodeBlockTab title="Request" file="list-user-feature-flags-request" />
+  <CodeBlockTab title="Response" file="list-user-feature-flags-response" />
+</CodeBlock>

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

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

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

@@ -0,0 +1,102 @@
+---
+descriptions:
+  check_authorization:
+    organization_membership_id: The ID of the organization membership to check.
+    permission_slug: The slug of the permission to check.
+    resource_id: >-
+      The ID of the resource to check. 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.
+    authorized: Whether the organization membership has the permission on the resource.
+reference:
+  curl:
+    - key: check_authorization
+      id: check_authorization
+      url: /reference/fga/access-check/check
+      title: >-
+        /authorization/organization_memberships/:organization_membership_id/check
+      type: POST
+      parameters:
+        - key: organization_membership_id
+          type: string
+          description: (check_authorization.organization_membership_id)
+        - key: permission_slug
+          type: string
+          description: (check_authorization.permission_slug)
+        - key: resource_id
+          type: string
+          optional: true
+          description: (check_authorization.resource_id)
+        - key: resource_external_id
+          type: string
+          optional: true
+          description: (check_authorization.resource_external_id)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (check_authorization.resource_type_slug)
+      returns:
+        - key: authorization_check
+          type: object
+          properties:
+            - key: authorized
+              type: boolean
+              description: (check_authorization.authorized)
+  js:
+    - key: check
+      id: check_authorization
+      url: /reference/fga/access-check/check
+      title: authorization.check()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationMembershipId
+              type: string
+              description: (check_authorization.organization_membership_id)
+            - key: permissionSlug
+              type: string
+              description: (check_authorization.permission_slug)
+            - key: resourceId
+              type: string
+              optional: true
+              description: (check_authorization.resource_id)
+            - key: resourceExternalId
+              type: string
+              optional: true
+              description: (check_authorization.resource_external_id)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (check_authorization.resource_type_slug)
+      returns:
+        - key: AuthorizationCheckResult
+          type: object
+          properties:
+            - key: authorized
+              type: boolean
+              description: (check_authorization.authorized)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/access-check/check.mdx
+---
+
+## Check authorization
+
+Check if an organization membership has a specific permission on a resource. This endpoint considers all sources of access:
+
+- Direct role assignments on the resource
+- Inherited permissions from parent resources
+- Organization-level roles
+
+You must provide either `resource_id` or both `resource_external_id` and `resource_type_slug` to identify the resource.
+
+<Callout type="info">
+  For org-wide permissions, you can check the JWT directly without making an API
+  call. Use this endpoint for resource-specific permission checks.
+</Callout>
+
+<CodeBlock referenceId="check_authorization">
+  <CodeBlockTab title="Request" file="check-authorization-request" />
+  <CodeBlockTab title="Response" file="check-authorization-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/access-check/index.mdx

@@ -0,0 +1,6 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/access-check/index.mdx
+---
+# Access Checks
+
+Access check endpoints help you answer authorization questions: "Can this user perform this action on this resource?" and "What resources can this user access?"

package/.docs/organized/docs/reference/fga/access-check/list-memberships-by-external-id.mdx

@@ -0,0 +1,143 @@
+---
+descriptions:
+  list_users_for_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.
+    permission_slug: >-
+      The permission slug to filter by. Only users with this permission on the
+      resource are returned.
+    assignment: >-
+      Filter by assignment type. Use "direct" for direct assignments only, or
+      "indirect" to include inherited assignments.
+    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 organization memberships that have access to the resource.
+reference:
+  curl:
+    - key: list_users_for_resource_by_external_id
+      id: list_users_for_resource_by_external_id
+      url: /reference/fga/access-check/list-memberships-by-external-id
+      title: >-
+        /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id/organization_memberships
+      type: GET
+      parameters:
+        - key: organization_id
+          type: string
+          description: (list_users_for_resource_by_external_id.organization_id)
+        - key: resource_type_slug
+          type: string
+          description: (list_users_for_resource_by_external_id.resource_type_slug)
+        - key: external_id
+          type: string
+          description: (list_users_for_resource_by_external_id.external_id)
+        - key: permission_slug
+          type: string
+          description: (list_users_for_resource_by_external_id.permission_slug)
+        - key: assignment
+          type: '"direct" | "indirect"'
+          optional: true
+          description: (list_users_for_resource_by_external_id.assignment)
+        - key: limit
+          type: number
+          optional: true
+          description: (list_users_for_resource_by_external_id.limit)
+        - key: before
+          type: string
+          optional: true
+          description: (list_users_for_resource_by_external_id.before)
+        - key: after
+          type: string
+          optional: true
+          description: (list_users_for_resource_by_external_id.after)
+        - key: order
+          type: '"asc" | "desc"'
+          optional: true
+          description: (list_users_for_resource_by_external_id.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_users_for_resource_by_external_id.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - key: before
+                  type: string | null
+                - key: after
+                  type: string | null
+  js:
+    - key: listMembershipsForResourceByExternalId
+      id: list_users_for_resource_by_external_id
+      url: /reference/fga/access-check/list-memberships-by-external-id
+      title: authorization.listMembershipsForResourceByExternalId()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (list_users_for_resource_by_external_id.organization_id)
+            - key: resourceTypeSlug
+              type: string
+              description: (list_users_for_resource_by_external_id.resource_type_slug)
+            - key: externalId
+              type: string
+              description: (list_users_for_resource_by_external_id.external_id)
+            - key: permissionSlug
+              type: string
+              description: (list_users_for_resource_by_external_id.permission_slug)
+            - key: assignment
+              type: '"direct" | "indirect"'
+              optional: true
+              description: (list_users_for_resource_by_external_id.assignment)
+            - key: limit
+              type: number
+              optional: true
+              description: (list_users_for_resource_by_external_id.limit)
+            - key: before
+              type: string
+              optional: true
+              description: (list_users_for_resource_by_external_id.before)
+            - key: after
+              type: string
+              optional: true
+              description: (list_users_for_resource_by_external_id.after)
+            - key: order
+              type: '"asc" | "desc"'
+              optional: true
+              description: (list_users_for_resource_by_external_id.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'OrganizationMembership[]'
+              description: (list_users_for_resource_by_external_id.data)
+            - key: listMetadata
+              type: ListMetadata
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/access-check/list-memberships-by-external-id.mdx
+---
+
+## List memberships for a resource by external ID
+
+Returns all organization memberships that have a specific permission on a resource, using the resource's external ID. This is useful for answering "Who can access this resource?" when you only have the external ID.
+
+<CodeBlock referenceId="list_users_for_resource_by_external_id">
+  <CodeBlockTab
+    title="Request"
+    file="list-memberships-for-resource-by-external-id-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="list-memberships-for-resource-by-external-id-response"
+  />
+</CodeBlock>

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

@@ -0,0 +1,127 @@
+---
+descriptions:
+  list_users_for_resource:
+    resource_id: The ID of the resource.
+    permission_slug: >-
+      The permission slug to filter by. Only users with this permission on the
+      resource are returned.
+    assignment: >-
+      Filter by assignment type. Use "direct" for direct assignments only, or
+      "indirect" to include inherited assignments.
+    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 organization memberships that have access to the resource.
+reference:
+  curl:
+    - key: list_users_for_resource
+      id: list_users_for_resource
+      url: /reference/fga/access-check/list-memberships
+      title: '/authorization/resources/:resource_id/organization_memberships'
+      type: GET
+      parameters:
+        - key: resource_id
+          type: string
+          description: (list_users_for_resource.resource_id)
+        - key: permission_slug
+          type: string
+          description: (list_users_for_resource.permission_slug)
+        - key: assignment
+          type: '"direct" | "indirect"'
+          optional: true
+          description: (list_users_for_resource.assignment)
+        - key: limit
+          type: number
+          optional: true
+          description: (list_users_for_resource.limit)
+        - key: before
+          type: string
+          optional: true
+          description: (list_users_for_resource.before)
+        - key: after
+          type: string
+          optional: true
+          description: (list_users_for_resource.after)
+        - key: order
+          type: '"asc" | "desc"'
+          optional: true
+          description: (list_users_for_resource.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_users_for_resource.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - key: before
+                  type: string | null
+                - key: after
+                  type: string | null
+  js:
+    - key: listMembershipsForResource
+      id: list_users_for_resource
+      url: /reference/fga/access-check/list-memberships
+      title: authorization.listMembershipsForResource()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: resourceId
+              type: string
+              description: (list_users_for_resource.resource_id)
+            - key: permissionSlug
+              type: string
+              description: (list_users_for_resource.permission_slug)
+            - key: assignment
+              type: '"direct" | "indirect"'
+              optional: true
+              description: (list_users_for_resource.assignment)
+            - key: limit
+              type: number
+              optional: true
+              description: (list_users_for_resource.limit)
+            - key: before
+              type: string
+              optional: true
+              description: (list_users_for_resource.before)
+            - key: after
+              type: string
+              optional: true
+              description: (list_users_for_resource.after)
+            - key: order
+              type: '"asc" | "desc"'
+              optional: true
+              description: (list_users_for_resource.order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'OrganizationMembership[]'
+              description: (list_users_for_resource.data)
+            - key: listMetadata
+              type: ListMetadata
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/access-check/list-memberships.mdx
+---
+
+## List memberships for a resource
+
+Returns all organization memberships that have a specific permission on a resource. This is useful for answering "Who can access this resource?"
+
+You can filter by assignment type to distinguish between direct assignments (role assigned directly on the resource) and indirect assignments (permission inherited from a parent resource).
+
+<CodeBlock referenceId="list_users_for_resource">
+  <CodeBlockTab title="Request" file="list-memberships-for-resource-request" />
+  <CodeBlockTab
+    title="Response"
+    file="list-memberships-for-resource-response"
+  />
+</CodeBlock>