@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/fga/warrant/list.mdx

@@ -0,0 +1,282 @@
+---
+descriptions:
+  list_warrants:
+    data: 'Array of [Warrants](/reference/fga/warrant).'
+    resource_type: >-
+      Only return warrants whose `resource_type` matches this value. This filter
+      is required if `resource_id` or `relation` is specified.
+    resource_id: Only return warrants whose `resource_id` matches this value.
+    relation: Only return warrants whose `relation` matches this value.
+    subject_type: >-
+      Only return warrants with a subject whose `resource_type` matches this
+      value. This filter is required if `subject_id` is specified.
+    subject_id: >-
+      Only return warrants with a subject whose `resource_id` matches this
+      value.
+    subject_relation: Only return warrants with a subject whose `relation` matches this value.
+reference:
+  curl:
+    - key: list_warrants
+      id: list_warrants
+      url: /reference/fga/warrants/list
+      title: /fga/v1/warrants
+      type: GET
+      parameters:
+        - key: warrant_token
+          type: string
+          optional: true
+          description: (warrant.warrant_token_header)
+        - key: resource_type
+          type: string
+          optional: true
+          description: (list_warrants.resource_type)
+        - key: resource_id
+          type: string
+          optional: true
+          description: (list_warrants.resource_id)
+        - key: relation
+          type: string
+          optional: true
+          description: (list_warrants.relation)
+        - key: subject_type
+          type: string
+          optional: true
+          description: (list_warrants.subject_type)
+        - key: subject_id
+          type: string
+          optional: true
+          description: (list_warrants.subject_id)
+        - key: subject_relation
+          type: string
+          optional: true
+          description: (list_warrants.subject_relation)
+        - (limit)
+        - (after)
+      returns:
+        - key: data
+          type: array
+          description: (list_warrants.data)
+        - key: list_metadata
+          type: object
+          properties:
+            - (after)
+  js:
+    - key: listWarrants
+      id: list_warrants
+      url: /reference/fga/warrants/list
+      title: fga.listWarrants()
+      type: GET
+      parameters:
+        - key: options
+          type: object
+          optional: true
+          properties:
+            - key: resourceType
+              type: string
+              optional: true
+              description: (list_warrants.resource_type)
+            - key: resourceId
+              type: string
+              optional: true
+              description: (list_warrants.resource_id)
+            - key: relation
+              type: string
+              optional: true
+              description: (list_warrants.relation)
+            - key: subjectType
+              type: string
+              optional: true
+              description: (list_warrants.subject_type)
+            - key: subjectId
+              type: string
+              optional: true
+              description: (list_warrants.subject_id)
+            - key: subjectRelation
+              type: string
+              optional: true
+              description: (list_warrants.subject_relation)
+            - (limit)
+            - (after)
+        - 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: data
+              type: 'Warrant[]'
+              description: (list_warrants.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (after)
+  go:
+    - key: ListWarrants
+      id: list_warrants
+      url: /reference/fga/warrants/list
+      title: fga.ListWarrants()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.ListWarrantsOpts
+          unwrap: true
+          properties:
+            - key: ResourceType
+              type: string
+              optional: true
+              description: (list_warrants.resource_type)
+            - key: ResourceId
+              type: string
+              optional: true
+              description: (list_warrants.resource_id)
+            - key: Relation
+              type: string
+              optional: true
+              description: (list_warrants.relation)
+            - key: SubjectType
+              type: string
+              optional: true
+              description: (list_warrants.subject_type)
+            - key: SubjectId
+              type: string
+              optional: true
+              description: (list_warrants.subject_id)
+            - key: SubjectRelation
+              type: string
+              optional: true
+              description: (list_warrants.subject_relation)
+            - key: WarrantToken
+              type: string
+              optional: true
+              description: (warrant.warrant_token)
+            - (Limit)
+            - (After)
+      returns:
+        - key: warrants
+          type: ListWarrantsResponse
+          unwrap: true
+          properties:
+            - key: Data
+              type: 'Warrant[]'
+              description: (list_warrants.data)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (After)
+        - (err)
+  java:
+    - key: listWarrants
+      id: list_warrants
+      url: /reference/fga/warrants/list
+      title: fga.listWarrants()
+      type: GET
+      parameters:
+        - key: options
+          type: ListWarrantsOptions
+          optional: true
+          unwrap: true
+          properties:
+            - key: resourceType
+              type: String
+              optional: true
+              description: (list_warrants.resource_type)
+            - key: resourceId
+              type: String
+              optional: true
+              description: (list_warrants.resource_id)
+            - key: relation
+              type: String
+              optional: true
+              description: (list_warrants.relation)
+            - key: subjectType
+              type: String
+              optional: true
+              description: (list_warrants.subject_type)
+            - key: subjectId
+              type: String
+              optional: true
+              description: (list_warrants.subject_id)
+            - key: subjectRelation
+              type: String
+              optional: true
+              description: (list_warrants.subject_relation)
+            - (limit)
+            - (after)
+        - 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: data
+              type: 'Array[Warrant]'
+              description: (list_warrants.data)
+            - key: listMetadata
+              type: ListMetadata
+              properties:
+                - (after)
+  python:
+    - key: list_warrants
+      id: list_warrants
+      url: /reference/fga/warrants/list
+      title: fga.list_warrants()
+      parameters:
+        - key: resource_type
+          type: str
+          optional: true
+          description: (list_warrants.resource_type)
+        - key: resource_id
+          type: str
+          optional: true
+          description: (list_warrants.resource_id)
+        - key: relation
+          type: str
+          optional: true
+          description: (list_warrants.relation)
+        - key: subject_type
+          type: str
+          optional: true
+          description: (list_warrants.subject_type)
+        - key: subject_id
+          type: str
+          optional: true
+          description: (list_warrants.subject_id)
+        - key: subject_relation
+          type: str
+          optional: true
+          description: (list_warrants.subject_relation)
+        - (limit)
+        - (after)
+      returns:
+        - key: data
+          type: 'List[Warrant]'
+          description: (list_warrants.data)
+        - key: list_metadata
+          type: ListMetadata
+          properties:
+            - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/list.mdx
+---
+
+## List warrants
+
+Get a list of all your existing warrants matching the criteria specified.
+
+<CodeBlock referenceId="list_warrants">
+  <CodeBlockTab title="Request" file="list-warrants-request" />
+  <CodeBlockTab title="Response" file="list-warrants-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/idempotency.mdx

@@ -0,0 +1,21 @@
+---
+descriptions:
+  idempotency_key: A unique string to prevent duplicate requests.
+reference:
+  dotnet:
+    - key: idempotencyKey
+      type: string
+      optional: true
+      description: (idempotency_key)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/idempotency.mdx
+---
+
+# Idempotency
+
+The WorkOS API supports idempotency which guarantees that performing the same operation multiple times will have the same result as if the operation were performed only once. This is handy in situations where you may need to retry a request due to a failure or prevent accidental duplicate requests from creating more than one resource.
+
+To achieve idempotency, you can add `Idempotency-Key` request header to any WorkOS API request with a unique string as the value. Each subsequent request matching this unique string will return the same response. We suggest using [v4 UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) for idempotency keys to avoid collisions.
+
+<CodeBlock title="Idempotency Key Example" file="set-idempotency-key-example" />
+
+Idempotency keys expire after 24 hours. The WorkOS API will generate a new response if you submit a request with an expired key.

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

@@ -0,0 +1,194 @@
+---
+descriptions:
+  client_id: >-
+    Identifies the application making the request to the WorkOS server. You can
+    obtain your client ID from the [API
+    Keys](https://dashboard.workos.com/api-keys) page in the dashboard.
+  client_secret: >
+    Authenticates the application making the request to the WorkOS server. You
+    can obtain your secret key from the [API
+    Keys](https://dashboard.workos.com/api-keys) page in the dashboard.
+  go:
+    error: >-
+      The built-in `error` interface, with the `nil` value representing no
+      error.
+    context: >-
+      The [Context](https://pkg.go.dev/context) type provides information about
+      the client making the request.
+  dotnet:
+    cancellation_token: >-
+      The [.NET Cancellation
+      Token](https://learn.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken?view=net-7.0)
+      can be used to cancel the request.
+    task: >-
+      An instance of [.NET
+      Task](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+      class.
+  java:
+    builder: A method for building the options object step by step.
+reference:
+  go:
+    - key: ctx
+      type: context.Context
+      description: (go.context)
+    - key: err
+      type: error
+      description: (go.error)
+  dotnet:
+    - key: cancellationToken
+      type: CancellationToken
+      optional: true
+      description: (dotnet.cancellation_token)
+    - key: Task
+      description: (dotnet.task)
+  js:
+    - url: >-
+        https://github.com/workos/authkit-nextjs/blob/main/src/authkit-callback-route.ts
+      key: handleAuth
+      id: handleAuth
+      title: handleAuth()
+      patternBefore: \s
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: returnPathname
+              optional: true
+              type: string
+            - key: baseURL
+              optional: true
+              type: string
+            - key: onSuccess
+              optional: true
+              type: function
+      returns:
+        - key: anonymous
+          type: Function
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+      key: getSignInUrl
+      id: getSignInUrl
+      title: getSignInUrl()
+      patternBefore: await
+      parameters: []
+      returns:
+        - key: anonymous
+          type: Promise<string>
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+      key: getSignUpUrl
+      id: getSignUpUrl
+      title: getSignUpUrl()
+      patternBefore: await
+      parameters: []
+      returns:
+        - key: anonymous
+          type: Promise<string>
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/auth.ts'
+      key: signOut
+      id: signOut
+      title: signOut()
+      patternBefore: await
+      parameters: []
+      returns:
+        - key: anonymous
+          type: Promise<void>
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/session.ts'
+      key: withAuth
+      id: withAuth
+      title: withAuth()
+      patternBefore: await
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: ensureSignedIn
+              optional: true
+              type: boolean
+      returns:
+        - key: anonymous
+          type: Promise<UserInfo | NoUserInfo>
+    - url: >-
+        https://github.com/workos/authkit-nextjs/blob/main/src/components/authkit-provider.ts
+      key: useAuth
+      id: useAuth
+      title: useAuth()
+      patternBefore: \s
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: ensureSignedIn
+              optional: true
+              type: boolean
+      returns:
+        - key: anonymous
+          type: Promise<UserInfo | NoUserInfo>
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/middleware.ts'
+      key: authkitMiddleware
+      id: authkitMiddleware
+      title: authkitMiddleware()
+      patternBefore: default
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: debug
+              optional: true
+              type: boolean
+            - key: redirectUri
+              optional: true
+              type: string
+            - key: middlewareAuth
+              optional: true
+              type: object
+            - key: signUpPaths
+              optional: true
+              type: array
+      returns:
+        - key: anonymous
+          type: NextMiddleware
+    - url: 'https://github.com/workos/authkit-nextjs/blob/main/src/middleware.ts'
+      key: authkit
+      id: authkit
+      title: authkit()
+      patternBefore: await
+      parameters:
+        - key: request
+          type: Request
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: debug
+              optional: true
+              type: boolean
+      returns:
+        - key: anonymous
+          type: Promise<AuthKitResponse>
+    - url: >-
+        https://github.com/workos/authkit-nextjs/blob/main/src/components/authkit-provider.tsx
+      key: AuthKitProvider
+      id: AuthKitProvider
+      title: AuthKitProvider
+      patternBefore: <
+      parameters:
+        - key: children
+          type: ReactNode
+        - key: onSessionExpired
+          optional: true
+          type: function
+originalPath: .tmp-workos-clone/packages/docs/content/reference/index.mdx
+---
+
+# API reference
+
+The WorkOS API enables adding Enterprise Ready features to your application. This REST API provides programmatic access to User Management, Single Sign-On, Directory Sync, and Audit Log resources.
+
+[Sign in](https://dashboard.workos.com/) to see code examples customized with your API keys and data.
+
+```url title="API Base URL"
+https://api.workos.com
+```

package/.docs/organized/docs/reference/magic-link/index.mdx

@@ -0,0 +1,8 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/magic-link/index.mdx
+---
+# Magic Link
+
+<DeprecationCallout.MagicLink />
+
+The Magic Link API can be used to add Passwordless Authentication to your app.