@workos/mcp-docs-server 0.1.0

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

@@ -0,0 +1,563 @@
+---
+descriptions:
+  check:
+    op: >
+      The operator to use when warrants contains a list of more than one
+      warrant. Supported values are `all_of`, `any_of`, and `batch`.
+
+
+      `all_of` - If `op` is `all_of`, the check endpoint returns a single check
+      result. The result is `Authorized` if all of the specified warrants are
+      matched. Otherwise, the result is `not_authorized`.
+
+
+      `any_of` - If `op` is `any_of`, the check endpoint returns a single check
+      result. The result is `Authorized` if any of the specified warrants are
+      matched. Otherwise, the result is `not_authorized`.
+
+
+      `batch` - If `op` is `batch`, the check endpoint returns a list of check
+      results (one for each warrant provided in `warrants`). The order of this
+      list will match the order of `warrants`.
+    context: >-
+      Contextual data to use for resolving the access check. This data will be
+      used when evaluating warrant policies.
+    check_result:
+      result: >
+        The result of the check request. `authorized` if the check request
+        matched a warrant and `not_authorized` otherwise.
+      is_implicit: >
+        Specifies whether the warrant match was found through a direct warrant
+        match or implicitly through a combination of other warrants and
+        inherited relations specified by a resource type.
+      warrant_token: |
+        The Warrant Token used to evaluate this check.
+reference:
+  curl:
+    - key: check
+      id: check
+      url: /reference/fga/check
+      title: /fga/v1/check
+      type: POST
+      parameters:
+        - key: warrant_token
+          type: string
+          optional: true
+          description: (warrant.warrant_token_header)
+        - key: op
+          type: string
+          optional: true
+          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: anonymous
+          type: object
+          unwrap: true
+          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)
+    - key: check_many
+      id: check_many
+      url: /reference/fga/check-many
+      title: /fga/v1/check
+      type: POST
+      parameters:
+        - key: warrant_token
+          type: string
+          optional: true
+          description: (warrant.warrant_token_header)
+        - key: op
+          type: string
+          optional: true
+          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: anonymous
+          type: object
+          unwrap: true
+          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: check
+      id: check
+      url: /reference/fga/check
+      title: fga.check()
+      parameters:
+        - key: options
+          type: object
+          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: relation
+              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)
+    - key: check_many
+      id: check_many
+      url: /reference/fga/check-many
+      title: fga.checkMany()
+      parameters:
+        - key: options
+          type: object
+          properties:
+            - key: op
+              type: string
+              description: (check.op)
+            - 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: relation
+                  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: anonymous
+          type: object
+          unwrap: true
+          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: check
+      id: check
+      url: /reference/fga/check
+      title: fga.Check()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.CheckOpts
+          expanded: true
+          properties:
+            - key: Op
+              type: string
+              description: (check.op)
+            - key: Checks
+              type: '[]fga.WarrantCheck'
+              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: response
+          type: fga.CheckResponse
+          unwrap: true
+          properties:
+            - key: Result
+              type: string
+              description: (check.check_result.result)
+            - key: IsImplicit
+              type: bool
+              description: (check.check_result.is_implicit)
+    - key: check_many
+      id: check_many
+      url: /reference/fga/check-many
+      title: fga.Check()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.CheckOpts
+          expanded: true
+          properties:
+            - key: Op
+              type: string
+              description: (check.op)
+            - key: Checks
+              type: '[]fga.WarrantCheck'
+              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: response
+          type: fga.CheckResponse
+          unwrap: true
+          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: check
+      id: check
+      url: /reference/fga/check
+      title: fga.check()
+      parameters:
+        - key: options
+          type: CheckOptions
+          properties:
+            - key: op
+              type: String
+              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: anonymous
+          type: CheckResponse
+          unwrap: true
+          properties:
+            - key: result
+              type: String
+              description: (check.check_result.result)
+            - key: isImplicit
+              type: Boolean
+              description: (check.check_result.is_implicit)
+    - key: check_many
+      id: check_many
+      url: /reference/fga/check-many
+      title: fga.check()
+      parameters:
+        - key: options
+          type: CheckOptions
+          properties:
+            - key: op
+              type: String
+              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: anonymous
+          type: object
+          unwrap: true
+          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: check
+      id: check
+      url: /reference/fga/check
+      title: fga.check()
+      parameters:
+        - key: checks
+          type: 'List[Dict[str, Any]]'
+          expanded: true
+          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
+              properties:
+                - key: resource_type
+                  type: str
+                - key: resource_id
+                  type: str
+                - key: relation
+                  type: str
+                  optional: true
+            - key: context
+              type: dict
+              optional: true
+              description: (check.context)
+        - key: warrant_token
+          type: str
+          optional: true
+          description: (warrant.warrant_token)
+      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: check_many
+      id: check_many
+      url: /reference/fga/check
+      title: fga.check()
+      parameters:
+        - key: checks
+          type: 'List[Dict[str, Any]]'
+          expanded: true
+          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
+              properties:
+                - key: resource_type
+                  type: str
+                - key: resource_id
+                  type: str
+                - key: relation
+                  type: str
+                  optional: true
+            - key: context
+              type: dict
+              optional: true
+              description: (check.context)
+        - key: op
+          type: str
+          optional: true
+          description: (check.op)
+        - key: warrant_token
+          type: str
+          optional: true
+          description: (warrant.warrant_token)
+      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/check.mdx
+---
+
+---
+
+# Check
+
+Check if a subject has a particular relation on a resource.
+
+## Single Check
+
+<CodeBlock referenceId="check">
+  <CodeBlockTab title="Request" file="check-request" />
+  <CodeBlockTab title="Response" file="check-response" />
+</CodeBlock>
+
+## Multiple Checks
+
+<CodeBlock referenceId="check_many">
+  <CodeBlockTab title="Request" file="check-many-request" />
+  <CodeBlockTab title="Response" file="check-many-response" />
+</CodeBlock>

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

@@ -0,0 +1,6 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/index.mdx
+---
+# 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.

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

@@ -0,0 +1,27 @@
+---
+reference:
+  curl:
+    - key: create_policy
+      id: create_policy
+      url: /reference/fga/policies/create
+      title: /fga/v1/policies
+      type: POST
+      parameters:
+        - (policy.name)
+        - (policy.description)
+        - (policy.language)
+        - (policy.parameters)
+        - (policy.expression)
+      returns:
+        - (policy)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/policy/create.mdx
+---
+
+## Create a policy
+
+Create a new policy in the current environment.
+
+<CodeBlock referenceId="create_policy">
+  <CodeBlockTab title="Request" file="create-policy-request" />
+  <CodeBlockTab title="Response" file="create-policy-response" />
+</CodeBlock>

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

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

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

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

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

@@ -0,0 +1,52 @@
+---
+descriptions:
+  policy:
+    name: Unique string ID of the policy.
+    description: Optional description of the policy.
+    language: 'Language of the policy. Currently, only `expr` is supported.'
+    parameters: Parameters to be used in the policy.
+    expression: The policy expression.
+    parameter_name: Name of the parameter.
+    parameter_type: >-
+      Type of the parameter. Supported types are `string`, `integer`, `boolean`,
+      `float`, `array` and `map`.
+reference:
+  curl:
+    - url: /reference/fga/policy
+      key: policy
+      id: policy
+      title: policy
+      properties:
+        - key: name
+          type: string
+          description: (policy.name)
+        - key: description
+          type: string
+          optional: true
+          description: (policy.description)
+        - key: language
+          type: string
+          description: (policy.language)
+        - key: parameters
+          type: array
+          unwrap: true
+          properties:
+            - key: name
+              type: string
+              description: (policy.parameter_name)
+            - key: type
+              type: string
+              description: (policy.parameter_type)
+        - key: expression
+          type: string
+          description: (policy.expression)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/policy/index.mdx
+---
+
+---
+
+# Policy
+
+Represents a policy that defines the access control rules for your application.
+
+<CodeBlock title="Policy" referenceId="policy" file="policy" />