@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/radar/attempts/create.mdx

@@ -0,0 +1,115 @@
+---
+descriptions:
+  create_attempt:
+    ip_address: The IP address of the client
+    user_agent: The user agent of the client
+    email: The email address of the user making the attempt
+    auth_method: |
+      The authentication method used for the attempt
+
+      Possible values:
+      - `Password`
+      - `Passkey`
+      - `Authenticator`
+      - `SMS_OTP`
+      - `Email_OTP`
+      - `Social`
+      - `SSO`
+      - `Other`
+    action: The action of the attempt. `sign-up` or `sign-in`
+  create_response:
+    verdict: |
+      The verdict of the response 
+
+      Possible values:
+      - `allow`
+      - `block` 
+      - `challenge`
+    reason: >-
+      The reason for the verdict, e.g. `detected_enabled_radar_control` or
+      `no_radar_control_detected`
+    attempt_id: The ID of the Radar attempt
+    control: |
+      The Radar control, only present if the verdict is `block` or `challenge`
+
+      Possible values:
+      - `bot_detection`
+      - `brute_force_attack`
+      - `credential_stuffing`
+      - `domain_sign_up_rate_limit`
+      - `ip_sign_up_rate_limit`
+      - `impossible_travel`
+      - `repeat_sign_up`
+      - `stale_account`
+      - `unrecognized_device`
+      - `restriction`
+    blocklist_type: |
+      The type of the blocklist if the verdict was `block` 
+
+      Possible values:
+      - `ip_address`
+      - `domain`
+      - `email`
+      - `device`
+      - `user_agent`
+      - `device_fingerprint`
+reference:
+  curl:
+    - url: /reference/radar/attempts/create
+      key: create_attempt
+      id: create_attempt
+      title: /radar/attempts
+      type: POST
+      properties:
+        - key: ip_address
+          type: string
+          description: (create_attempt.ip_address)
+        - key: user_agent
+          type: string
+          description: (create_attempt.user_agent)
+        - key: email
+          type: string
+          description: (create_attempt.email)
+        - key: auth_method
+          type: >-
+            "Password" | "Passkey" | "Authenticator" | "SMS_OTP" | "Email_OTP" |
+            "Social" | "SSO" | "Other"
+          description: (create_attempt.auth_method)
+        - key: action
+          type: '"sign-up" | "sign-in"'
+          description: (create_attempt.action)
+      returns:
+        - key: verdict
+          type: '"allow" | "block" | "challenge"'
+          description: (create_response.verdict)
+        - key: reason
+          type: string
+          description: (create_response.reason)
+        - key: attempt_id
+          type: string
+          description: (create_response.attempt_id)
+        - key: control
+          type: >-
+            "bot_detection" | "brute_force_attack" | "credential_stuffing" |
+            "domain_sign_up_rate_limit" | "ip_sign_up_rate_limit" |
+            "impossible_travel" | "repeat_sign_up" | "stale_account" |
+            "unrecognized_device" | "restriction"
+          optional: true
+          description: (create_response.control)
+        - key: blocklist_type
+          type: >-
+            "ip_address" | "domain" | "email" | "device" | "user_agent" |
+            "device_fingerprint"
+          optional: true
+          description: (create_response.blocklist_type)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/attempts/create.mdx
+---
+
+## Create an Attempt
+
+Evaluates an authentication attempt based on the parameters provided and returns a verdict.
+
+<CodeBlock referenceId="create_attempt">
+  <CodeBlockTab title="Request" file="create-attempt-request" />
+  <CodeBlockTab title="Response" file="create-attempt-response" />
+</CodeBlock>

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

@@ -0,0 +1,7 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/attempts/index.mdx
+---
+
+## Attempts
+
+A Radar attempt represents a sign-in or signup attempt and includes context such as IP address and user agent. The Radar engine assesses attempts for risk and returns a decision that you can use to drive behavior in your application.

package/.docs/organized/docs/reference/radar/attempts/update.mdx

@@ -0,0 +1,34 @@
+---
+descriptions:
+  update_attempt:
+    id: The ID of the Radar attempt
+    challenge_status: The status of the challenge
+    attempt_status: The status agent of the attempt
+reference:
+  curl:
+    - url: /reference/radar/attempts/update
+      key: update_attempt
+      id: update_attempt
+      title: '/radar/attempts/:id'
+      type: PUT
+      parameters:
+        - key: id
+          type: string
+          description: (update_attempt.id)
+      properties:
+        - key: challenge_status
+          type: '"success"'
+          description: (update_attempt.challenge_status)
+        - key: attempt_status
+          type: '"success"'
+          description: (update_attempt.attempt_status)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/attempts/update.mdx
+---
+
+## Update an Attempt
+
+You may optionally inform Radar that an authentication attempt or challenge was successful using this endpoint. Some Radar controls depend on tracking recent successful attempts, such as impossible travel.
+
+<CodeBlock referenceId="update_attempt">
+  <CodeBlockTab title="Request" file="update-attempt-request" />
+</CodeBlock>

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

@@ -0,0 +1,8 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/index.mdx
+---
+# Radar
+
+Radar allows you to detect, verify, and block harmful behavior in real time. The Radar API supports the management of WorkOS Radar block and allow lists as well as standalone Radar use-cases. While Radar is natively integrated with AuthKit, you can also leverage Radar's risk decisioning engine outside of AuthKit to detect fraudulent sign-in and signup attempts in your own custom authentication flows using the [attempts API](/reference/radar/attempts).
+
+The Radar standalone API is currently in preview, [contact us](mailto:support@workos.com) to request access.

package/.docs/organized/docs/reference/radar/lists/delete.mdx

@@ -0,0 +1,36 @@
+---
+descriptions:
+  delete_list:
+    entry: The value of the entry
+    type: The type of the Radar list
+    action: The action of the Radar list
+reference:
+  curl:
+    - url: /reference/radar/lists/delete
+      key: delete_from_list
+      id: delete_from_list
+      title: '/radar/lists/:type/:action'
+      type: DELETE
+      properties:
+        - key: entry
+          type: string
+          description: (update_list.entry)
+      parameters:
+        - key: type
+          type: >-
+            "ip_address" | "domain" | "email" | "device" | "user_agent" |
+            "device_fingerprint"
+          description: (update_list.type)
+        - key: action
+          type: '"block" | "allow"'
+          description: (update_list.action)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/lists/delete.mdx
+---
+
+## Remove Entry
+
+Removes an entry from a Radar list
+
+<CodeBlock referenceId="delete_from_list">
+  <CodeBlockTab title="Request" file="delete-from-radar-list-request" />
+</CodeBlock>

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

@@ -0,0 +1,7 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/lists/index.mdx
+---
+
+## Radar lists
+
+Radar supports explicitly blocking and allowing attempts based on attempt attributes. You can manage these lists via the Radar list management APIs

package/.docs/organized/docs/reference/radar/lists/update.mdx

@@ -0,0 +1,36 @@
+---
+descriptions:
+  update_list:
+    entry: The value of the entry
+    type: The type of the Radar list
+    action: The action of the Radar list
+reference:
+  curl:
+    - url: /reference/radar/lists/update
+      key: update_list
+      id: update_list
+      title: '/radar/lists/:type/:action'
+      type: POST
+      properties:
+        - key: entry
+          type: string
+          description: (update_list.entry)
+      parameters:
+        - key: type
+          type: >-
+            "ip_address" | "domain" | "email" | "device" | "user_agent" |
+            "device_fingerprint"
+          description: (update_list.type)
+        - key: action
+          type: '"block" | "allow"'
+          description: (update_list.action)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/radar/lists/update.mdx
+---
+
+## Add Entry
+
+Adds an entry to a Radar list
+
+<CodeBlock referenceId="update_list">
+  <CodeBlockTab title="Request" file="update-radar-list-request" />
+</CodeBlock>

package/.docs/organized/docs/reference/rate-limits.mdx

@@ -0,0 +1,50 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/rate-limits.mdx
+---
+# Rate limits
+
+WorkOS APIs are rate limited to ensure that they are fast for everyone. If you find yourself getting 429 errors, double check your integration to make sure you aren’t making unnecessary requests.
+
+## General
+
+| Name         | Path | Limit                                        |
+| ------------ | ---- | -------------------------------------------- |
+| All requests | \*   | 6,000 requests per 60 seconds per IP address |
+
+This rate limits applies to all environments, staging and production. Exceptions to the general rate limit are listed below.
+
+## Single Sign-On
+
+| Name                                                          | Path           | Limit                                        |
+| ------------------------------------------------------------- | -------------- | -------------------------------------------- |
+| [Get Authorization URL](/reference/sso/get-authorization-url) | /sso/authorize | 1,000 requests per 60 seconds per connection |
+
+## Directory Sync
+
+| Name                                                        | Path             | Limit                               |
+| ----------------------------------------------------------- | ---------------- | ----------------------------------- |
+| [Directory Users](/reference/directory-sync/directory-user) | /directory_users | 4 requests per second per directory |
+
+## User Management
+
+Rate limiting for User Management APIs are enforced on an account basis.
+
+| Name                                                                | Path                                         | Limit                                                |
+| ------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------- |
+| Reads                                                               | /user_management/\*                          | 1,000 requests per 10 seconds                        |
+| Writes                                                              | /user_management/\*                          | 500 requests per 10 seconds                          |
+| [Authentication](/reference/user-management/authentication)         | /user_management/authenticate                | 10 requests per 60 seconds per email or challenge ID |
+| [Magic Auth](/reference/user-management/magic-auth)                 | /user_management/magic_auth/send             | 3 requests per 60 seconds per email                  |
+| [Email verification](/reference/user-management/email-verification) | /user_management/:id/email_verification/send | 3 requests per 60 seconds per user                   |
+| [Password reset](/reference/user-management/password-reset)         | /user_management/password_reset/send         | 3 requests per 60 seconds per email                  |
+
+## Hosted AuthKit
+
+| Name                     | Limits                                                     |
+| ------------------------ | ---------------------------------------------------------- |
+| Reads                    | 1,000 requests per 10 seconds                              |
+| Writes                   | 500 requests per 10 seconds                                |
+| SSO sign-ins             | 3 requests per 60 seconds per IP address                   |
+| Email sign-ins           | 10 requests per 60 seconds per email and IP address        |
+| Magic Auth sign-ins      | 10 requests per 60 seconds per IP address and challenge ID |
+| Magic Auth code requests | 3 requests per 60 seconds per IP address and email         |

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

@@ -0,0 +1,268 @@
+---
+descriptions:
+  role:
+    self: 'The [Role](/reference/roles) object.'
+    object: Distinguishes the Role object.
+    id: Unique identifier of the Role.
+    name: A descriptive name for the Role. This field does not need to be unique.
+    slug: A unique key to reference the role.
+    description: A description for the Role.
+    permissions: A list of permission slugs assigned to the role.
+    type: 'The type of Role, either `EnvironmentRole` or `OrganizationRole`.'
+    created_at: The timestamp when the Role was last created.
+    updated_at: The timestamp when the Role was last updated.
+reference:
+  curl:
+    - url: /reference/roles
+      key: role
+      id: role
+      title: Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: string
+          description: (role.id)
+        - key: name
+          type: string
+          description: (role.name)
+        - key: slug
+          type: string
+          description: (role.slug)
+        - key: description
+          type: string | null
+          description: (role.description)
+        - key: type
+          type: '"EnvironmentRole" | "OrganizationRole"'
+          description: (role.type)
+        - key: created_at
+          type: string
+          description: (role.created_at)
+        - key: updated_at
+          type: string
+          description: (role.updated_at)
+  js:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: interface Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: string
+          description: (role.id)
+        - key: name
+          type: string
+          description: (role.name)
+        - key: slug
+          type: string
+          description: (role.slug)
+        - key: description
+          type: string | null
+          description: (role.description)
+        - key: permissions
+          type: 'string[]'
+          description: (role.permissions)
+        - key: type
+          type: '"EnvironmentRole" | "OrganizationRole"'
+          description: (role.type)
+        - key: createdAt
+          type: string
+          description: (role.created_at)
+        - key: updatedAt
+          type: string
+          description: (role.updated_at)
+  go:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: roles.Role
+      properties:
+        - key: ID
+          type: string
+          description: (role.id)
+        - key: Name
+          type: string
+          description: (role.name)
+        - key: Slug
+          type: string
+          description: (role.slug)
+        - key: Description
+          type: string
+          optional: true
+          description: (role.description)
+        - key: Type
+          type: RoleType
+          description: (role.type)
+        - key: CreatedAt
+          type: string
+          description: (role.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (role.updated_at)
+  java:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: class Role
+      properties:
+        - key: obj
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: String
+          description: (role.id)
+        - key: name
+          type: String
+          description: (role.name)
+        - key: slug
+          type: String
+          description: (role.slug)
+        - key: description
+          type: String
+          optional: true
+          description: (role.description)
+        - key: type
+          type: RoleType
+          description: (role.type)
+        - key: createdAt
+          type: String
+          description: (role.created_at)
+        - key: updatedAt
+          type: String
+          description: (role.updated_at)
+  python:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: str
+          description: (role.id)
+        - key: name
+          type: str
+          description: (role.name)
+        - key: slug
+          type: str
+          description: (role.slug)
+        - key: description
+          type: str
+          optional: true
+          description: (role.description)
+        - key: type
+          type: '"EnvironmentRole" | "OrganizationRole"'
+          description: (role.type)
+        - key: created_at
+          type: str
+          description: (role.created_at)
+        - key: updated_at
+          type: str
+          description: (role.updated_at)
+  ruby:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: class Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: String
+          description: (role.id)
+        - key: name
+          type: String
+          description: (role.name)
+        - key: slug
+          type: String
+          description: (role.slug)
+        - key: description
+          type: String
+          optional: true
+          description: (role.description)
+        - key: type
+          type: '"EnvironmentRole" | "OrganizationRole"'
+          description: (role.type)
+        - key: created_at
+          type: String
+          description: (role.created_at)
+        - key: updated_at
+          type: String
+          description: (role.updated_at)
+  php:
+    - url: /reference/roles
+      id: role
+      key: Role
+      title: WorkOS\Resource\Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: string
+          description: (role.id)
+        - key: name
+          type: string
+          description: (role.name)
+        - key: slug
+          type: string
+          description: (role.slug)
+        - key: description
+          type: string
+          optional: true
+          description: (role.description)
+        - key: type
+          type: '"EnvironmentRole" | "OrganizationRole"'
+          description: (role.type)
+        - key: createdAt
+          type: string
+          description: (role.created_at)
+        - key: updatedAt
+          type: string
+          description: (role.updated_at)
+  dotnet:
+    - url: /reference/roles
+      key: Role
+      id: role
+      title: class Role
+      properties:
+        - key: Object
+          type: '"role"'
+          description: (role.object)
+        - key: Id
+          type: string
+          description: (role.id)
+        - key: Name
+          type: string
+          description: (role.name)
+        - key: Slug
+          type: string
+          description: (role.slug)
+        - key: Description
+          type: string
+          optional: true
+          description: (role.description)
+        - key: Type
+          type: RoleType
+          description: (role.type)
+        - key: CreatedAt
+          type: string
+          description: (organization.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (organization.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/index.mdx
+---
+
+# Roles
+
+A role is an access control resource that can be assigned to [organization memberships](/reference/user-management/organization-membership), [directory users](/directory-sync/identity-provider-role-assignment), and [SSO profiles](/sso/identity-provider-role-assignment).
+
+<CodeBlock title="Example Role" file="role" referenceId="role" />