@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/fga/resource-type/apply.mdx

@@ -0,0 +1,35 @@
+---
+descriptions:
+  apply_resource_types:
+    resource_types: List of resource types set in the current environment.
+reference:
+  curl:
+    - key: apply_resource_types
+      id: apply_resource_types
+      url: /reference/fga/resource-types
+      title: /fga/v1/resource-types
+      type: PUT
+      parameters:
+        - key: resource_types
+          type: array
+          expanded: true
+          properties:
+            - (resource_type.type)
+            - (resource_type.relations)
+      returns:
+        - key: resource_types
+          type: array
+          description: (apply_resource_types.resource_types)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/apply.mdx
+---
+
+## Apply resource types
+
+Sets resource types in the current environment to match the provided resource types.
+
+> This endpoint performs a batch operation which will override your entire schema for the environment. Any existing resource types not included in the request will be deleted.
+
+<CodeBlock referenceId="apply_resource_types">
+  <CodeBlockTab title="Request" file="apply-resource-types-request" />
+  <CodeBlockTab title="Response" file="apply-resource-types-response" />
+</CodeBlock>

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

@@ -0,0 +1,24 @@
+---
+reference:
+  curl:
+    - key: create_resource_type
+      id: create_resource_type
+      url: /reference/fga/resource-types/create
+      title: /fga/v1/resource-types
+      type: POST
+      parameters:
+        - (resource_type.type)
+        - (resource_type.relations)
+      returns:
+        - (resource_type)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/create.mdx
+---
+
+## Create a resource type
+
+Create a new resource type in the current environment.
+
+<CodeBlock referenceId="create_resource_type">
+  <CodeBlockTab title="Request" file="create-resource-type-request" />
+  <CodeBlockTab title="Response" file="create-resource-type-response" />
+</CodeBlock>

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

@@ -0,0 +1,22 @@
+---
+reference:
+  curl:
+    - key: delete_resource_type
+      id: delete_resource_type
+      url: /reference/fga/resource-types/delete
+      title: '/fga/v1/resource-types/:type'
+      type: DELETE
+      parameters:
+        - (resource_type.type)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/delete.mdx
+---
+
+## Delete a resource type
+
+Deletes a resource type in the current environment.
+
+<CodeBlock
+  title="Request"
+  referenceId="delete_resource_type"
+  file="delete-resource-type"
+/>

package/.docs/organized/docs/reference/fga/resource-type/get.mdx

@@ -0,0 +1,23 @@
+---
+reference:
+  curl:
+    - key: get_resource_type
+      id: get_resource_type
+      url: /reference/fga/resource-types/get
+      title: '/fga/v1/resource-types/:type'
+      type: GET
+      parameters:
+        - (resource_type.type)
+      returns:
+        - (resource_type)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/get.mdx
+---
+
+## Get a resource type
+
+Get the definition of an existing resource type.
+
+<CodeBlock referenceId="get_resource_type">
+  <CodeBlockTab title="Request" file="get-resource-type-request" />
+  <CodeBlockTab title="Response" file="get-resource-type-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/resource-type/index.mdx

@@ -0,0 +1,68 @@
+---
+descriptions:
+  resource_type:
+    type: Unique string ID of the resource type.
+    relations:
+      allowed_types: List of resource types that can have this relationship.
+      inherit_if: >-
+        Relation that must be inherited from the parent resource type for this
+        relationship to be inherited. Can also be any_of, all_of, or none_of for
+        logical combinations of relations.
+      of_type: >-
+        Resource type that this relationship is inherited from.Use this field to
+        define resource inheritance rules.
+      with_relation: >-
+        Relation that must exist on the parent resource type for this
+        relationship to be inherited. Use this field to define resource
+        inheritance rules.
+      rules: >-
+        Rules that define how the relationship is inherited from other resource
+        types. Rules are recursively defined with the same type as relations.
+      policy: The policy name that this relationship is inherited from.
+    relation: Name of relationship that resources can have on resources of this type.
+reference:
+  curl:
+    - url: /reference/fga/resource-type
+      key: resource_type
+      id: resource_type
+      title: resource_type
+      properties:
+        - key: type
+          type: string
+          description: (resource_type.type)
+        - key: relations
+          type: object
+          unwrap: true
+          properties:
+            - key: allowed_types
+              type: array
+              description: (resource_type.relations.allowed_types)
+            - key: inherit_if
+              type: string
+              description: (resource_type.relations.inherit_if)
+            - key: of_type
+              type: string
+              description: (resource_type.relations.of_type)
+            - key: with_relation
+              type: string
+              description: (resource_type.relations.with_relation)
+            - key: rules
+              type: array
+              description: (resource_type.relations.rules)
+            - key: policy
+              type: string
+              description: (resource_type.relations.policy)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/index.mdx
+---
+
+---
+
+# Resource Type
+
+Represents a type of resource and its possible relationships in your application. See [Resource Types](/fga/schema/schema-syntax/resource-types) to learn more about relation rules. See [JSON Syntax](/fga/schema/schema-syntax) for more examples.
+
+<CodeBlock
+  title="Resource Type"
+  referenceId="resource_type"
+  file="resource_type"
+/>

package/.docs/organized/docs/reference/fga/resource-type/list.mdx

@@ -0,0 +1,36 @@
+---
+descriptions:
+  list_resource_types:
+    data: 'Array of [Resource Types](/reference/fga/resource-type).'
+reference:
+  curl:
+    - key: list_resource_types
+      id: list_resource_types
+      url: /reference/resource-types/list
+      title: /fga/v1/resource-types
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: data
+          type: array
+          description: (list_resource_types.data)
+        - key: list_metadata
+          type: object
+          properties:
+            - (before)
+            - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/list.mdx
+---
+
+## List resource types
+
+Get a list of all your existing resource types matching the criteria specified.
+
+<CodeBlock referenceId="list_resource_types">
+  <CodeBlockTab title="Request" file="list-resource-types-request" />
+  <CodeBlockTab title="Response" file="list-resource-types-response" />
+</CodeBlock>

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

@@ -0,0 +1,23 @@
+---
+reference:
+  curl:
+    - key: update_resource_type
+      id: update_resource_type
+      url: '/reference/fga/resource-types/:type'
+      title: /fga/v1/resource-types
+      type: PUT
+      parameters:
+        - (resource_type.relations)
+      returns:
+        - (resource_type)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/update.mdx
+---
+
+## Update a resource type
+
+Update properties of a resource type.
+
+<CodeBlock referenceId="update_resource_type">
+  <CodeBlockTab title="Request" file="update-resource-type-request" />
+  <CodeBlockTab title="Response" file="update-resource-type-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/schema/apply.mdx

@@ -0,0 +1,42 @@
+---
+reference:
+  curl:
+    - key: apply_schema
+      id: apply_schema
+      url: /reference/fga/schema/apply
+      title: /fga/v1/schema
+      type: POST
+      parameters:
+        - key: resource_types
+          type: array
+          expanded: true
+          properties:
+            - (resource_type.type)
+            - (resource_type.relations)
+        - key: policies
+          type: object
+          expanded: true
+          properties:
+            - (policy.name)
+            - (policy.description)
+            - (policy.language)
+            - (policy.parameters)
+            - (policy.expression)
+      returns:
+        - key: schema
+          url: /reference/fga/schema
+          id: fga_schema
+          title: schema
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/apply.mdx
+---
+
+## Apply schema
+
+Sets resource types and policies in the current environment.
+
+> This endpoint performs a batch operation which will override your entire schema for the environment. Any existing resource types and policies not included in the request will be deleted.
+
+<CodeBlock referenceId="apply_schema">
+  <CodeBlockTab title="Request" file="apply-schema-request" />
+  <CodeBlockTab title="Response" file="apply-schema-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/schema/get.mdx

@@ -0,0 +1,24 @@
+---
+reference:
+  curl:
+    - key: get_schema
+      id: get_schema
+      url: /reference/fga/schema/get
+      title: /fga/v1/schema
+      type: GET
+      returns:
+        - key: schema
+          url: /reference/fga/schema
+          id: fga_schema
+          title: schema
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/get.mdx
+---
+
+## Get a schema
+
+Get the authorization model for your current environment.
+
+<CodeBlock referenceId="get_schema">
+  <CodeBlockTab title="Request" file="get-schema-request" />
+  <CodeBlockTab title="Response" file="get-schema-response" />
+</CodeBlock>

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

@@ -0,0 +1,39 @@
+---
+descriptions:
+  schema:
+    self: 'The FGA [Schema](/reference/fga/schema).'
+reference:
+  curl:
+    - key: schema
+      url: /reference/fga/schema
+      id: fga_schema
+      title: schema
+      properties:
+        - key: version
+          type: string
+          description: The version of the transpiler used to convert to schema language.
+        - key: resource_types
+          type: array
+          description: 'Array of [Resource Types](/reference/fga/resource-type).'
+          unwrap: true
+          properties:
+            - (resource_type.type)
+            - (resource_type.relations)
+        - key: policies
+          type: object
+          description: 'Array of [Policies](/reference/fga/policy).'
+          unwrap: true
+          properties:
+            - (policy.name)
+            - (policy.description)
+            - (policy.language)
+            - (policy.parameters)
+            - (policy.expression)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/index.mdx
+---
+
+# Schema
+
+Represents the authorization model in your FGA environment. Includes resource type definitions and policies that define how authorization checks are processed.
+
+<CodeBlock title="Schema" referenceId="schema" file="schema" />

package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx

@@ -0,0 +1,226 @@
+---
+reference:
+  curl:
+    - key: batch_write_warrants
+      id: batch_write_warrants
+      url: /reference/fga/warrants/batch-write
+      title: /fga/v1/warrants
+      type: POST
+      parameters:
+        - key: warrants
+          type: array
+          expanded: true
+          properties:
+            - key: op
+              type: '"create" | "delete"'
+              optional: true
+              description: (write_warrant.op)
+            - (warrant.resource_type)
+            - (warrant.resource_id)
+            - (warrant.relation)
+            - (warrant.subject)
+            - (warrant.policy)
+      returns:
+        - key: warrant_token
+          type: string
+          description: (warrant.warrant_token)
+  js:
+    - key: batchWriteWarrants
+      id: batch_write_warrants
+      url: /reference/fga/warrants/batch-write
+      title: fga.batchWriteWarrants()
+      parameters:
+        - key: warrants
+          type: array
+          expanded: true
+          properties:
+            - key: op
+              type: '"create" | "delete"'
+              optional: true
+              description: (write_warrant.op)
+            - 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: policy
+              type: string
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: string
+              description: (warrant.warrant_token)
+  go:
+    - key: BatchWriteWarrants
+      id: batch_write_warrants
+      url: /reference/fga/warrants/batch-write
+      title: fga.BatchWriteWarrants()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: array
+          expanded: true
+          properties:
+            - key: opts
+              type: fga.WriteWarrantOpts
+              unwrap: true
+              properties:
+                - key: Op
+                  type: '"create" | "delete"'
+                  optional: true
+                  description: (write_warrant.op)
+                - 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
+                  unwrap: true
+                  properties:
+                    - key: ResourceType
+                      type: string
+                    - key: ResourceId
+                      type: string
+                    - key: Relation
+                      type: string
+                      optional: true
+                - key: Policy
+                  type: string
+                  optional: true
+                  description: (warrant.policy)
+      returns:
+        - key: response
+          type: fga.WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: WarrantToken
+              type: string
+              description: (warrant.warrant_token)
+  java:
+    - key: batchWriteWarrants
+      id: batch_write_warrants
+      url: /reference/fga/warrants/batch-write
+      title: fga.batchWriteWarrants()
+      parameters:
+        - key: options
+          type: List<WriteWarrantOptions>
+          expanded: true
+          properties:
+            - key: op
+              type: '"create" | "delete"'
+              optional: true
+              description: (write_warrant.op)
+            - 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
+              unwrap: true
+              properties:
+                - key: resourceType
+                  type: String
+                - key: resourceId
+                  type: String
+                - key: relation
+                  type: String
+                  optional: true
+            - key: policy
+              type: String
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: String
+              description: (warrant.warrant_token)
+  python:
+    - key: batch_write_warrants
+      id: batch_write_warrants
+      url: /reference/fga/warrants/batch-write
+      title: fga.batch_write_warrants()
+      parameters:
+        - key: warrants
+          type: 'List[WriteWarrantOptions]'
+          expanded: true
+          properties:
+            - key: op
+              type: '"create" | "delete"'
+              optional: true
+              description: (write_warrant.op)
+            - 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: Subject
+              unwrap: true
+              properties:
+                - key: resource_type
+                  type: str
+                - key: resource_id
+                  type: str
+                - key: relation
+                  type: str
+                  optional: true
+            - key: policy
+              type: str
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: fga.WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrant_token
+              type: str
+              description: (warrant.warrant_token)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/batch-write.mdx
+---
+
+## Batch Write Warrants
+
+Executes a batch of warrant writes in the current environment.
+
+<CodeBlock referenceId="batch_write_warrants">
+  <CodeBlockTab title="Request" file="batch-write-warrants-request" />
+  <CodeBlockTab title="Response" file="batch-write-warrants-response" />
+</CodeBlock>