@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/fga/warrants.mdx

@@ -1,92 +0,0 @@
----
-title: Warrants
-description: Warrants specify relationships between resources in your application.
-showNextPage: true
-originalPath: .tmp-workos-clone/packages/docs/content/fga/warrants.mdx
----
-
-**Warrants** are access rules that specify relationships between the resources in your application (e.g. `[store:A] is [parent] of [item:123]`). WorkOS FGA uses the set warrants and resource types for an application to answer access checks and queries. Individual warrants define explicit relations between resources while resource types define rules (policies) by which some relationships can exist implicitly.
-
-## Overview
-
-```shell
-   tenant:stark-industries  #  admin  @  user:tony-stark
-              |                  |              |
-           Resource           Relation       Subject
-```
-
-Each warrant is composed of three core attributes and an optional _policy_ (more on this later):
-
-- **Resource** - This is the resource the warrant specifies a relationship on. The resource is broken down into a `resource_type` and a `resource_id`. The `resource_type` must refer to a valid [resource type](/fga/schema/schema-syntax/resource-types) defined for the application. The `resource_id` must be a unique identifier used by the application to identify the resource.
-- **Relation** - This is the relationship the warrant specifies between the resource and the subject. The relation must be one of the defined [relations](/fga/schema/schema-syntax/relations) on the referenced `resource_type`. It is often used to specify an action the warrant will grant the subject the ability to perform on the resource (e.g. `editor`, `viewer`, etc.).
-- **Subject** - This is the resource being granted the specified relation. Like the resource, the subject is broken down into a `resource_type`, and a `resource_id`, and optionally a `relation` (to specify a group of subjects). A subject's `resource_type` must refer to a valid resource type defined for the application, and its `resource_id` must be a unique identifier used by the application to identify the resource. While the subject will often times be an individual user or resource, the subject can also specify a _group_ of resources (e.g. in [group warrants](#group-warrants)).
-- **Policy** (optional) - The policy specifies an additional boolean expression to be evaluated _at the time of each check/query request_. The provided expression can reference arbitrary variables which can be provided in check or query requests as _context_. Given some context at check/query time, a warrant's policy must evaluate to `true` in order for the warrant to be considered a match for the check/query. If a warrant's resource, relation, and subject attributes do not match the requested check/query **or** the policy expression evaluates to `false`, the warrant will not be matched during evaluation of the check/query. The policy attribute can be used to implement a form of attribute-based access control (ABAC).
-
-Here is an example warrant specifying that the subject `user:ABC` has the relation `editor` on resource `item:123`:
-
-```json
-{
-  "resource_type": "item",
-  "resource_id": "123",
-  "relation": "editor",
-  "subject": {
-    "resource_type": "user",
-    "resource_id": "ABC"
-  }
-}
-```
-
-## Direct Warrants
-
-A direct warrant represents a relationship between a resource and a _specific_ subject. For example, we can define a warrant specifying that `[user:1] is a [member] of [role:admin]`:
-
-```json
-{
-  "resource_type": "role",
-  "resource_id": "admin",
-  "relation": "member",
-  "subject": {
-    "resource_type": "user",
-    "resource_id": "1"
-  }
-}
-```
-
-## Group Warrants
-
-In some cases, we might need to specify a relationship between a resource and a _group_ of subjects (e.g. `[member]s of [role:admin]`, `[manager]s of [tenant:acme]`, etc). Group warrants are warrants that include the optional `relation` attribute on the `subject`. They specify that _all_ resources matching the subject's `resource_type`, `resource_id`, and `relation` will have the specified `relation` on the resource. For example, we can define a group warrant specifying that `[member]s of [role:admin] are [editor]s of [report:1]`:
-
-```json
-{
-  "resource_type": "report",
-  "resource_id": "1",
-  "relation": "editor",
-  "subject": {
-    "resource_type": "role",
-    "resource_id": "admin",
-    "relation": "member"
-  }
-}
-```
-
-It's important to note that resource inheritance rules achieve the same thing as group warrants, but group warrants are a data-first approach. Group warrants are typically used as an exception for certain resources that might have different sets of requirements than the schema. We typically recommend using resource inheritance rules over group warrants because it is easier to manage a single schema than a set of group warrants defined on several different resources.
-
-## Wildcard Warrants
-
-While FGA is designed to model fine-grained authorization, some use-cases call for more coarse-grained access to individual resources. For example, publicly sharing read privileges on a particular document with all users. Scenarios like this can be modeled using wildcard warrants. A wildcard warrant is a warrant that specifies a wildcard (`*`) for the `subject_id` attribute. This means the warrant applies to _all_ subjects of the specified `subject_type`. Note that group warrants cannot specify a wildcard as the `subject_id`. Here is an example of a wildcard warrant that grants _all users_ `viewer` access to `document:doc_123`:
-
-```json
-{
-  "resource_type": "document",
-  "resource_id": "doc_123",
-  "relation": "viewer",
-  "subject": {
-    "resource_type": "user",
-    "resource_id": "*"
-  }
-}
-```
-
-## Creating and Managing Warrants
-
-Warrants can be created directly in the [FGA dashboard](https://fga.workos.com) or programmatically via API. Refer to the [Warrants API Reference](/reference/fga/warrant/list) to learn more about managing Warrants via API.

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

@@ -1,277 +0,0 @@
----
-descriptions:
-  check:
-    batch_op: >
-      Returns a list of check results (one for each check provided in `checks`).
-      The order of this list will match the order of `checks`.
-reference:
-  curl:
-    - key: batch_check
-      id: batch_check
-      url: /reference/fga/batch-check
-      title: /fga/v1/check
-      type: POST
-      parameters:
-        - key: warrant_token
-          type: string
-          optional: true
-          description: (warrant.warrant_token_header)
-        - key: op
-          type: '"batch"'
-          description: (check.op)
-        - key: checks
-          type: array
-          expanded: true
-          properties:
-            - (warrant.resource_type)
-            - (warrant.resource_id)
-            - (warrant.relation)
-            - (warrant.subject)
-            - key: context
-              type: object
-              optional: true
-              description: (check.context)
-      returns:
-        - key: results
-          type: array
-          properties:
-            - key: result
-              type: string
-              description: (check.check_result.result)
-            - key: is_implicit
-              type: boolean
-              description: (check.check_result.is_implicit)
-            - key: warrant_token
-              type: string
-              description: (check.check_result.warrant_token)
-  js:
-    - key: batchCheck
-      id: batch_check
-      url: /reference/fga/batch-check
-      title: fga.checkBatch()
-      parameters:
-        - key: options
-          type: object
-          properties:
-            - key: checks
-              type: array
-              properties:
-                - key: resource
-                  type: object
-                  unwrap: true
-                  properties:
-                    - key: resourceType
-                      type: string
-                      description: (warrant.resource_type)
-                    - key: resourceId
-                      type: string
-                      description: (warrant.resource_id)
-                - key: relation
-                  type: string
-                  description: (warrant.relation)
-                - key: subject
-                  type: object
-                  unwrap: true
-                  properties:
-                    - key: resourceType
-                      type: string
-                    - key: resourceId
-                      type: string
-                    - key: relation
-                      type: string
-                      optional: true
-                - key: context
-                  type: object
-                  optional: true
-                  description: (check.context)
-        - key: requestOptions
-          type: object
-          optional: true
-          properties:
-            - key: warrantToken
-              type: string
-              optional: true
-              description: (warrant.warrant_token)
-      returns:
-        - key: checkResults
-          type: array
-          properties:
-            - key: result
-              type: string
-              description: (check.check_result.result)
-            - key: isImplicit
-              type: boolean
-              description: (check.check_result.is_implicit)
-            - key: warrantToken
-              type: string
-              description: (check.check_result.warrant_token)
-  go:
-    - key: BatchCheck
-      id: batch_check
-      url: /reference/fga/batch-check
-      title: fga.BatchCheck()
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.BatchCheckOpts
-          expanded: true
-          properties:
-            - key: Checks
-              type: array
-              expanded: true
-              properties:
-                - key: ResourceType
-                  type: string
-                  description: (warrant.resource_type)
-                - key: ResourceId
-                  type: string
-                  description: (warrant.resource_id)
-                - key: Relation
-                  type: string
-                  description: (warrant.relation)
-                - key: Subject
-                  type: fga.Subject
-                  properties:
-                    - key: ResourceType
-                      type: string
-                    - key: ResourceId
-                      type: string
-                    - key: Relation
-                      type: string
-                      optional: true
-                - key: Context
-                  type: 'map[string]interface{}'
-                  optional: true
-                  description: (check.context)
-            - key: WarrantToken
-              type: string
-              optional: true
-              description: (warrant.warrant_token)
-      returns:
-        - key: checkResponses
-          type: '[]fga.CheckResponse'
-          properties:
-            - key: Result
-              type: string
-              description: (check.check_result.result)
-            - key: IsImplicit
-              type: bool
-              description: (check.check_result.is_implicit)
-            - key: WarrantToken
-              type: string
-              description: (check.check_result.warrant_token)
-  java:
-    - key: batchCheck
-      id: batch_check
-      url: /reference/fga/batch-check
-      title: fga.checkBatch()
-      parameters:
-        - key: options
-          type: CheckBatchOptions
-          properties:
-            - key: op
-              type: '"batch"'
-              description: (check.op)
-            - key: checks
-              type: List<WarrantCheckOptions>
-              properties:
-                - key: resourceType
-                  type: String
-                  description: (warrant.resource_type)
-                - key: resourceId
-                  type: String
-                  description: (warrant.resource_id)
-                - key: relation
-                  type: String
-                  description: (warrant.relation)
-                - key: subject
-                  type: Subject
-                  description: (warrant.subject)
-                - key: context
-                  type: 'Map<String, Any>'
-                  optional: true
-                  description: (check.context)
-        - key: requestOptions
-          type: CheckRequestOptions
-          optional: true
-          properties:
-            - key: warrantToken
-              type: String
-              optional: true
-              description: (warrant.warrant_token)
-      returns:
-        - key: checkResults
-          type: Array<CheckResponse>
-          properties:
-            - key: result
-              type: String
-              description: (check.check_result.result)
-            - key: isImplicit
-              type: boolean
-              description: (check.check_result.is_implicit)
-            - key: warrantToken
-              type: string
-              description: (check.check_result.warrant_token)
-  python:
-    - key: batch_check
-      id: batch_check
-      url: /reference/fga/batch-check
-      title: fga.check_batch()
-      parameters:
-        - key: warrant_token
-          type: str
-          optional: true
-          description: (warrant.warrant_token)
-        - key: checks
-          expanded: true
-          type: 'List[Dict[str, Any]]'
-          properties:
-            - key: resource_type
-              type: str
-              description: (warrant.resource_type)
-            - key: resource_id
-              type: str
-              description: (warrant.resource_id)
-            - key: relation
-              type: str
-              description: (warrant.relation)
-            - key: subject
-              type: 'Dict[str, Any]'
-              properties:
-                - key: resource_type
-                  type: str
-                - key: resource_id
-                  type: str
-                - key: relation
-                  type: str
-                  optional: true
-            - key: context
-              type: 'Dict[str, Any]'
-              optional: true
-              description: (check.context)
-      returns:
-        - key: results
-          type: 'List[CheckResponse]'
-          properties:
-            - key: result
-              type: str
-              description: (check.check_result.result)
-            - key: is_implicit
-              type: bool
-              description: (check.check_result.is_implicit)
-            - key: warrant_token
-              type: string
-              description: (check.check_result.warrant_token)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/batch-check.mdx
----
-
----
-
-# Batch Check
-
-Executes a batch of checks and returns a list of results in a single operation.
-
-<CodeBlock referenceId="batch_check">
-  <CodeBlockTab title="Request" file="batch-check-request" />
-  <CodeBlockTab title="Response" file="batch-check-response" />
-</CodeBlock>