@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/invitation/send.mdx

@@ -0,0 +1,230 @@
+---
+descriptions:
+  send_invitation:
+    expires_in_days: |
+      How many days the invitations will be valid for.
+
+      Must be between 1 and 30 days. Defaults to 7 days if not specified.
+    inviter_user_id: >-
+      The ID of the [user](/reference/user-management/user) who invites the
+      recipient. The invitation email will mention the name of this user.
+    role_slug: >-
+      The [role](/user-management/roles) that the recipient will receive when
+      they join the organization in the invitation.
+reference:
+  curl:
+    - key: send_invitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: /user_management/invitations
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: string
+          description: (invitation.email)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (invitation.organization_id)
+        - key: expires_in_days
+          optional: true
+          type: int
+          description: (send_invitation.expires_in_days)
+        - key: inviter_user_id
+          optional: true
+          type: string
+          description: (send_invitation.inviter_user_id)
+        - key: role_slug
+          optional: true
+          type: String
+          description: (send_invitation.role_slug)
+      returns:
+        - (invitation)
+  js:
+    - key: sendInvitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: userManagement.sendInvitation()
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: string
+          description: (invitation.email)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (invitation.organization_id)
+        - key: expiresInDays
+          optional: true
+          type: int
+          description: (send_invitation.expires_in_days)
+        - key: inviterUserId
+          optional: true
+          type: string
+          description: (send_invitation.inviter_user_id)
+        - key: roleSlug
+          optional: true
+          type: String
+          description: (send_invitation.role_slug)
+      returns:
+        - (Invitation)
+  go:
+    - key: SendInvitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: usermanagement.SendInvitation()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.SendInvitationOpts
+          unwrap: true
+          properties:
+            - key: Email
+              type: string
+              description: (invitation.email)
+            - key: OrganizationID
+              type: string
+              optional: true
+              description: (invitation.organization_id)
+            - key: ExpiresInDays
+              optional: true
+              type: int
+              description: (send_invitation.expires_in_days)
+            - key: InviterUserId
+              optional: true
+              type: string
+              description: (send_invitation.inviter_user_id)
+            - key: RoleSlug
+              optional: true
+              type: String
+              description: (send_invitation.role_slug)
+      returns:
+        - key: invitation
+          type: usermanagement.Invitation
+          description: (invitation.self)
+        - (err)
+  php:
+    - key: sendInvitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: $userManagement->sendInvitation()
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: string
+          description: (invitation.email)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (invitation.organization_id)
+        - key: expiresInDays
+          optional: true
+          type: int
+          description: (send_invitation.expires_in_days)
+        - key: inviterUserId
+          optional: true
+          type: string
+          description: (send_invitation.inviter_user_id)
+      returns:
+        - (Invitation)
+  python:
+    - key: send_invitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: user_management.send_invitation()
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: str
+          description: (invitation.email)
+        - key: organization_id
+          optional: true
+          type: str
+          description: (invitation.organization_id)
+        - key: expires_in_days
+          optional: true
+          type: int
+          description: (send_invitation.expires_in_days)
+        - key: inviter_user_id
+          optional: true
+          type: str
+          description: (send_invitation.inviter_user_id)
+        - key: role_slug
+          optional: true
+          type: str
+          description: (send_invitation.role_slug)
+      returns:
+        - (Invitation)
+  ruby:
+    - key: send_invitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: UserManagement.send_invitation()
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: String
+          description: (invitation.email)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (invitation.organization_id)
+        - key: expires_in_days
+          optional: true
+          type: Integer
+          description: (send_invitation.expires_in_days)
+        - key: inviter_user_id
+          optional: true
+          type: String
+          description: (send_invitation.inviter_user_id)
+      returns:
+        - (Invitation)
+  java:
+    - key: sendInvitation
+      id: send_invitation
+      url: /reference/user-management/invitation/send
+      title: userManagement.sendInvitation()
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: options
+          type: SendInvitationOptions
+          unwrap: true
+          properties:
+            - key: email
+              type: String
+              description: (invitation.email)
+            - key: organizationId
+              optional: true
+              type: String
+              description: (invitation.organization_id)
+            - key: expiresInDays
+              optional: true
+              type: Integer
+              description: (send_invitation.expires_in_days)
+            - key: inviterUserId
+              optional: true
+              type: String
+              description: (send_invitation.inviter_user_id)
+            - key: roleSlug
+              optional: true
+              type: String
+              description: (send_invitation.role_slug)
+      returns:
+        - (Invitation)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/invitation/send.mdx
+---
+
+## Send an invitation
+
+Sends an invitation email to the recipient.
+
+<CodeBlock referenceId="send_invitation">
+  <CodeBlockTab title="Request" file="send-invitation-request" />
+  <CodeBlockTab title="Response" file="send-invitation-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/logout/get-logout-url-from-session-cookie.mdx

@@ -0,0 +1,52 @@
+---
+descriptions:
+  logout:
+    session_data: WorkOS session cookie value from the user's browser.
+    cookie_password_unseal: >
+      Password used to unseal the session cookie. Must be the same as the
+      password used to seal the cookie. Can optionally be specified as the
+      `WORKOS_COOKIE_PASSWORD` environment variable.
+reference:
+  js:
+    - key: getLogoutUrlFromSessionCookie
+      id: get_logout_url_from_session_cookie
+      url: /reference/user-management/logout/get-logout-url-from-session-cookie
+      title: userManagement.getLogoutUrlFromSessionCookie()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: sessionData
+              type: string
+              description: (logout.session_data)
+            - key: cookiePassword
+              type: string
+              optional: true
+              description: (logout.cookie_password_unseal)
+            - key: returnTo
+              type: string
+              optional: true
+              description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/logout/get-logout-url-from-session-cookie.mdx
+---
+
+# Get logout URL from session cookie
+
+Generates the logout URL by extracting the session ID from the session cookie. Use this over `getLogoutUrl` if you don't have a saved reference to the session ID and you'd like the SDK to handle extracting the session ID from the cookie for you.
+
+<CodeBlock referenceId="get_logout_url_from_session_cookie">
+  <CodeBlockTab
+    title="Request"
+    file="get-logout-url-from-session-cookie-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="get-logout-url-from-session-cookie-response"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/logout/get-logout-url.mdx

@@ -0,0 +1,147 @@
+---
+descriptions:
+  logout:
+    session_id: >-
+      The ID of the session that is ending. This can be extracted from the `sid`
+      claim of the access token.
+reference:
+  curl:
+    - key: get_logout_url
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: /user_management/sessions/logout
+      type: GET
+      parameters:
+        - key: session_id
+          type: string
+          description: (logout.session_id)
+        - key: return_to
+          optional: true
+          type: string
+          description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+  js:
+    - key: getLogoutUrl
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: userManagement.getLogoutUrl()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: sessionId
+              type: string
+              description: (logout.session_id)
+            - key: returnTo
+              optional: true
+              type: string
+              description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+  go:
+    - key: GetLogoutUrl
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: usermanagement.GetLogoutUrl()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.GetLogoutURLOpts
+          unwrap: true
+          properties:
+            - key: SessionID
+              type: string
+              description: (logout.session_id)
+            - key: ReturnTo
+              optional: true
+              type: string
+              description: (logout.return_to)
+      returns:
+        - key: response
+          type: string
+          description: (logout.url)
+        - (err)
+  ruby:
+    - key: get_logout_url
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: UserManagement.get_logout_url()
+      parameters:
+        - key: session_id
+          type: string
+          description: (logout.session_id)
+        - key: return_to
+          optional: true
+          type: string
+          description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+  java:
+    - key: getLogoutUrl
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: userManagement.getLogoutUrl()
+      parameters:
+        - key: sessionId
+          type: string
+          description: (logout.session_id)
+        - key: returnTo
+          optional: true
+          type: string
+          description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+  python:
+    - key: get_logout_url
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: user_management.get_logout_url()
+      parameters:
+        - key: session_id
+          type: str
+          description: (logout.session_id)
+        - key: return_to
+          optional: true
+          type: str
+          description: (logout.return_to)
+      returns:
+        - key: url
+          type: str
+          description: (logout.url)
+  php:
+    - key: get_logout_url
+      id: get_logout_url
+      url: /reference/user-management/logout/get-logout-url
+      title: $userManagement->getLogoutUrl()
+      parameters:
+        - key: session_id
+          type: string
+          description: (logout.session_id)
+        - key: return_to
+          optional: true
+          type: string
+          description: (logout.return_to)
+      returns:
+        - key: url
+          type: string
+          description: (logout.url)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/logout/get-logout-url.mdx
+---
+
+# Get logout URL
+
+<CodeBlock referenceId="get_logout_url">
+  <CodeBlockTab title="Request" file="get-logout-url-request" />
+  <CodeBlockTab title="Response" file="get-logout-url-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/logout/index.mdx

@@ -0,0 +1,26 @@
+---
+descriptions:
+  logout:
+    session_id: >-
+      The ID of the session that is ending. This can be extracted from the `sid`
+      claim of the access token.
+    url: The user's browser should be redirected to this URL to sign them out.
+    return_to: >
+      The location the user's browser should be redirected to by the WorkOS API
+      after
+
+      the session has been ended. Allowed values are configured in the WorkOS
+      Dashboard under
+
+      [_Logout
+      redirects_](/user-management/sessions/configuring-sessions/logout-redirect).
+
+
+      If no value is given the default Logout URI will be used instead.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/logout/index.mdx
+---
+
+# Logout
+
+End a user's session. The user's browser should be redirected to this URL.

package/.docs/organized/docs/reference/user-management/magic-auth/create.mdx

@@ -0,0 +1,148 @@
+---
+descriptions:
+  create_magic_auth:
+    invitation_token: >
+      The token of an [invitation](/reference/user-management/invitation). The
+      invitation should be in the pending state.
+
+
+      When a valid invitation token is specified, the user is able to sign up
+      even if it is disabled in the environment. Additionally, if the invitation
+      was for a specific organization, attaching the token to a user's
+      authenticate call automatically provisions their membership to the
+      organization.
+reference:
+  curl:
+    - key: create_magic_auth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: /user_management/magic_auth
+      type: POST
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: string
+          description: (magic_auth.email)
+        - key: invitation_token
+          optional: true
+          type: string
+          description: (create_magic_auth.invitation_token)
+      returns:
+        - (magic_auth)
+  js:
+    - key: createMagicAuth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: userManagement.createMagicAuth()
+      sendsEmail: true
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: email
+              type: string
+              description: (magic_auth.email)
+            - key: invitationToken
+              optional: true
+              type: string
+              description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+  go:
+    - key: CreateMagicAuth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: usermanagement.CreateMagicAuth()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.CreateMagicAuthOpts
+          unwrap: true
+          properties:
+            - key: Email
+              type: string
+              description: (magic_auth.email)
+            - key: InvitationToken
+              optional: true
+              type: string
+              description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+        - (err)
+  php:
+    - key: createMagicAuth=
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: $userManagement->createMagicAuth()
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: string
+          description: (magic_auth.email)
+        - key: invitationToken
+          optional: true
+          type: string
+          description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+  python:
+    - key: create_magic_auth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: user_management.create_magic_auth()
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: str
+          description: (magic_auth.email)
+        - key: invitation_token
+          optional: true
+          type: str
+          description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+  ruby:
+    - key: create_magic_auth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: UserManagement.create_magic_auth()
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: String
+          description: (magic_auth.email)
+        - key: invitation_token
+          optional: true
+          type: String
+          description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+  java:
+    - key: createMagicAuth
+      id: create_magic_auth
+      url: /reference/user-management/magic-auth/create
+      title: userManagement.createMagicAuth()
+      sendsEmail: true
+      parameters:
+        - key: email
+          type: String
+          description: (magic_auth.email)
+        - key: invitationToken
+          optional: true
+          type: String
+          description: (create_magic_auth.invitation_token)
+      returns:
+        - (MagicAuth)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/magic-auth/create.mdx
+---
+
+## Create a Magic Auth code
+
+Creates a one-time authentication code that can be sent to the user’s email address. The code expires in 10 minutes. To verify the code, [authenticate the user with Magic Auth](/reference/user-management/authentication/magic-auth).
+
+<CodeBlock referenceId="create_magic_auth">
+  <CodeBlockTab title="Request" file="create-magic-auth-request" />
+  <CodeBlockTab title="Response" file="create-magic-auth-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/user-management/magic-auth/get.mdx

@@ -0,0 +1,88 @@
+---
+reference:
+  curl:
+    - key: get_magic_auth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: '/user_management/magic_auth/:id'
+      type: GET
+      parameters:
+        - (magic_auth.id)
+      returns:
+        - (magic_auth)
+  js:
+    - key: getMagicAuth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: userManagement.getMagicAuth()
+      parameters:
+        - (MagicAuth.id)
+      returns:
+        - (MagicAuth)
+  go:
+    - key: getMagicAuth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: usermanagement.GetMagicAuth()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.GetMagicAuthOpts
+          unwrap: true
+          properties:
+            - key: MagicAuth
+              type: string
+              description: (magic_auth.id)
+      returns:
+        - (MagicAuth)
+        - (err)
+  php:
+    - key: getMagicAuth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: $userManagement->getMagicAuth()
+      parameters:
+        - (MagicAuth.id)
+      returns:
+        - (MagicAuth)
+  python:
+    - key: get_magic_auth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: user_management.get_magic_auth()
+      parameters:
+        - key: magic_auth_id
+          type: str
+          description: (magic_auth.id)
+      returns:
+        - (MagicAuth)
+  ruby:
+    - key: get_magic_auth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: UserManagement.get_magic_auth()
+      parameters:
+        - (MagicAuth.id)
+      returns:
+        - (MagicAuth)
+  java:
+    - key: getMagicAuth
+      id: get_magic_auth
+      url: /reference/user-management/magic-auth/get
+      title: userManagement.getMagicAuth()
+      parameters:
+        - (MagicAuth.id)
+      returns:
+        - (MagicAuth)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/magic-auth/get.mdx
+---
+
+## Get a Magic Auth code
+
+Get the details of an existing Magic Auth code that can be used to send an email to a user for authentication.
+
+<CodeBlock referenceId="get_magic_auth">
+  <CodeBlockTab title="Request" file="get-magic-auth-request" />
+  <CodeBlockTab title="Response" file="get-magic-auth-response" />
+</CodeBlock>