@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/user-management/user/update.mdx

@@ -0,0 +1,344 @@
+---
+descriptions:
+  update_user:
+    first_name: The user’s first name.
+    last_name: The user’s last name.
+    email: >
+      The user’s email address.
+
+
+      Changing a user's email will set `email_verified` to false.
+      [Identities](/reference/user-management/identity) that do not match the
+      new email will be unlinked.
+    email_verified: >
+      Whether the user’s email address was previously verified.
+
+
+      You should normally use the [email verification
+      flow](/reference/user-management/authentication/email-verification)
+
+      to verify a user’s email address. However, if the user’s email was
+      previously verified, or
+
+      is being migrated from an existing user store, this can be set to `true`
+      to mark it as
+
+      already verified.
+    metadata: >-
+      Object containing [metadata](/user-management/metadata) key/value pairs
+      associated with the user.
+    external_id: >-
+      The [external identifier](/user-management/metadata/external-identifiers)
+      of the user.
+reference:
+  curl:
+    - key: update_user
+      id: update_user
+      url: /reference/user-management/user/update
+      title: '/user_management/users/:id'
+      type: PUT
+      parameters:
+        - (user.id)
+        - key: first_name
+          type: string
+          optional: true
+          description: (update_user.first_name)
+        - key: last_name
+          type: string
+          optional: true
+          description: (update_user.last_name)
+        - key: email
+          type: string
+          optional: true
+          description: (update_user.email)
+        - key: email_verified
+          type: boolean
+          optional: true
+          description: (update_user.email_verified)
+        - key: password
+          type: string
+          optional: true
+          description: (create_user.password)
+        - key: password_hash
+          type: string
+          optional: true
+          description: (create_user.password_hash)
+        - key: password_hash_type
+          type: string
+          optional: true
+          description: (create_user.password_hash_type)
+        - key: external_id
+          type: string
+          optional: true
+          description: (user.external_id)
+        - key: metadata
+          type: object
+          optional: true
+          description: (user.metadata)
+      returns:
+        - (user)
+  js:
+    - key: updateUser
+      id: update_user
+      url: /reference/user-management/user/update
+      title: userManagement.updateUser()
+      parameters:
+        - key: userId
+          type: string
+          description: (user.id)
+        - key: firstName
+          type: string
+          optional: true
+          description: (update_user.first_name)
+        - key: lastName
+          type: string
+          optional: true
+          description: (update_user.last_name)
+        - key: email
+          type: string
+          optional: true
+          description: (update_user.email)
+        - key: emailVerified
+          type: boolean
+          optional: true
+          description: (update_user.email_verified)
+        - key: password
+          type: string
+          optional: true
+          description: (create_user.password)
+        - key: passwordHash
+          type: string
+          optional: true
+          description: (create_user.password_hash)
+        - key: passwordHashType
+          type: string
+          optional: true
+          description: (create_user.password_hash_type)
+        - key: externalId
+          type: string
+          optional: true
+          description: (user.external_id)
+        - key: metadata
+          type: object
+          optional: true
+          description: (user.metadata)
+      returns:
+        - (User)
+  php:
+    - key: updateUser
+      id: update_user
+      url: /reference/user-management/user/update
+      title: $userManagement->updateUser()
+      parameters:
+        - key: id
+          type: string
+          description: (user.id)
+        - key: firstName
+          type: string
+          optional: true
+          description: (update_user.first_name)
+        - key: lastName
+          type: string
+          optional: true
+          description: (update_user.last_name)
+        - key: email
+          type: string
+          optional: true
+          description: (update_user.email)
+        - key: emailVerified
+          type: boolean
+          optional: true
+          description: (update_user.email_verified)
+        - key: password
+          type: string
+          optional: true
+          description: (create_user.password)
+        - key: passwordHash
+          type: string
+          optional: true
+          description: (create_user.password_hash)
+        - key: passwordHashType
+          type: string
+          optional: true
+          description: (create_user.password_hash_type)
+      returns:
+        - (User)
+  go:
+    - key: UpdateUser
+      id: update_user
+      url: /reference/user-management/user/update
+      title: usermanagement.UpdateUser()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: usermanagement.UpdateUserOpts
+          unwrap: true
+          properties:
+            - key: User
+              type: string
+              description: (user.id)
+            - key: FirstName
+              type: string
+              optional: true
+              description: (update_user.first_name)
+            - key: LastName
+              type: string
+              optional: true
+              description: (update_user.last_name)
+            - key: Email
+              type: string
+              optional: true
+              description: (update_user.email)
+            - key: EmailVerified
+              type: boolean
+              optional: true
+              description: (update_user.email_verified)
+            - key: Password
+              type: string
+              optional: true
+              description: (create_user.password)
+            - key: PasswordHash
+              type: string
+              optional: true
+              description: (create_user.password_hash)
+            - key: PasswordHashType
+              type: string
+              optional: true
+              description: (create_user.password_hash_type)
+      returns:
+        - key: user
+          type: usermanagement.User
+          description: (user.self)
+        - (err)
+  python:
+    - key: update_user
+      id: update_user
+      url: /reference/user-management/user/update
+      title: user_management.update_user()
+      parameters:
+        - key: user_id
+          type: str
+          description: (user.id)
+        - key: first_name
+          type: str
+          optional: true
+          description: (update_user.first_name)
+        - key: last_name
+          type: str
+          optional: true
+          description: (update_user.last_name)
+        - key: email
+          type: str
+          optional: true
+          description: (update_user.email)
+        - key: email_verified
+          type: bool
+          optional: true
+          description: (update_user.email_verified)
+        - key: password
+          type: str
+          optional: true
+          description: (create_user.password)
+        - key: password_hash
+          type: str
+          optional: true
+          description: (create_user.password_hash)
+        - key: password_hash_type
+          type: PasswordHashType
+          optional: true
+          description: (create_user.password_hash_type)
+      returns:
+        - (User)
+  ruby:
+    - key: update_user
+      id: update_user
+      url: /reference/user-management/user/update
+      title: UserManagement.update_user()
+      parameters:
+        - key: id
+          type: String
+          description: (user.id)
+        - key: first_name
+          type: String
+          optional: true
+          description: (update_user.first_name)
+        - key: last_name
+          type: String
+          optional: true
+          description: (update_user.last_name)
+        - key: email
+          type: String
+          optional: true
+          description: (update_user.email)
+        - key: email_verified
+          type: Boolean
+          optional: true
+          description: (update_user.email_verified)
+        - key: password
+          type: String
+          optional: true
+          description: (create_user.password)
+        - key: password_hash
+          type: String
+          optional: true
+          description: (create_user.password_hash)
+        - key: password_hash_type
+          type: String
+          optional: true
+          description: (create_user.password_hash_type)
+      returns:
+        - (User)
+  java:
+    - key: updateUser
+      id: update_user
+      url: /reference/user-management/user/update
+      title: userManagement.updateUser()
+      parameters:
+        - key: userId
+          type: String
+          description: (user.id)
+        - key: options
+          type: UpdateUserOptions
+          unwrap: true
+          properties:
+            - key: id
+              type: String
+              description: (user.id)
+            - key: firstName
+              type: String
+              optional: true
+              description: (update_user.first_name)
+            - key: lastName
+              type: String
+              optional: true
+              description: (update_user.last_name)
+            - key: emailVerified
+              type: Boolean
+              optional: true
+              description: (update_user.email_verified)
+            - key: password
+              type: String
+              optional: true
+              description: (create_user.password)
+            - key: passwordHash
+              type: String
+              optional: true
+              description: (create_user.password_hash)
+            - key: passwordHashType
+              type: PasswordHashTypeEnumType
+              optional: true
+              description: (create_user.password_hash_type)
+      returns:
+        - (User)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/user-management/user/update.mdx
+---
+
+## Update a user
+
+Updates properties of a user. The omitted properties will be left unchanged.
+
+<CodeBlock referenceId="update_user">
+  <CodeBlockTab title="Request" file="update-user-request" />
+  <CodeBlockTab title="Response" file="update-user-response" />
+</CodeBlock>

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

@@ -0,0 +1,6 @@
+---
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/index.mdx
+---
+# Vault
+
+Vault provides centralized encryption and storage of sensitive data such as API keys, database credentials, or personally identifiable information (PII). All data is encrypted using keys automatically provisioned based on the provided context of the object.

package/.docs/organized/docs/reference/vault/key/create-data-key.mdx

@@ -0,0 +1,106 @@
+---
+reference:
+  curl:
+    - key: create_data_key
+      id: create_data_key
+      url: /reference/vault/key/create-data-key
+      title: /vault/v1/keys/data-key
+      type: POST
+      parameters:
+        - key: context
+          type: object
+          description: (object_metadata.context)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: id
+              type: string
+              description: (data_key.id)
+            - key: data_key
+              type: string
+              description: (data_key.key)
+            - key: encrypted_keys
+              type: string
+              description: (data_key.encrypted_keys)
+            - key: context
+              type: object
+              description: (object_metadata.context)
+  js:
+    - key: createDataKey
+      id: create_data_key
+      url: /reference/vault/key/create-data-key
+      title: vault.createDataKey()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: context
+              type: object
+              description: (object_metadata.context)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: dataKey
+              type: object
+              properties:
+                - key: id
+                  type: string
+                  description: (data_key.id)
+                - key: key
+                  type: string
+                  description: (data_key.key)
+            - key: encryptedKeys
+              type: string
+              description: (data_key.encrypted_keys)
+            - key: context
+              type: object
+              description: (object_metadata.context)
+  go:
+    - key: CreateDataKey
+      id: create_data_key
+      title: vault.CreateDataKey()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.CreateDataKeyOpts
+          expanded: true
+          properties:
+            - key: KeyContext
+              type: vault.KeyContext
+              description: (object_metadata.context)
+      returns:
+        - key: response
+          type: vault.DataKeyPair
+          unwrap: true
+          properties:
+            - key: Id
+              type: string
+              description: (data_key.id)
+            - key: DataKey
+              type: string
+              description: (data_key.key)
+            - key: EncryptedKeys
+              type: string
+              description: (data_key.encrypted_keys)
+            - key: KeyContext
+              type: vault.KeyContext
+              description: (object_metadata.context)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/vault/key/create-data-key.mdx
+---
+
+## Create a data key
+
+Generate a data key for local encryption based on the provided key context.
+
+The encrypted data key **MUST** be stored by the application, as it cannot be retrieved after generation.
+
+<CodeBlock referenceId="create_data_key">
+  <CodeBlockTab title="Request" file="create-data-key-request" />
+  <CodeBlockTab title="Response" file="create-data-key-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx

@@ -0,0 +1,84 @@
+---
+reference:
+  curl:
+    - key: decrypt_data_key
+      id: decrypt_data_key
+      url: /reference/vault/key/decrypt-data-key
+      title: /vault/v1/keys/decrypt
+      type: POST
+      parameters:
+        - key: keys
+          type: string
+          description: (data_key.encrypted_keys)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: id
+              type: string
+              description: (data_key.id)
+            - key: data_key
+              type: string
+              description: (data_key.key)
+  js:
+    - key: decryptDataKey
+      id: decrypt_data_key
+      url: /reference/vault/key/decrypt-data-key
+      title: vault.decryptDataKey()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: keys
+              type: string
+              description: (data_key.encrypted_keys)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: id
+              type: string
+              description: (data_key.id)
+            - key: key
+              type: string
+              description: (data_key.key)
+  go:
+    - key: DecryptDataKey
+      id: decrypt_data_key
+      url: /reference/vault/key/decrypt-data-key
+      title: vault.DecryptDataKey()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.DecryptDataKeyOpts
+          expanded: true
+          properties:
+            - key: Keys
+              type: string
+              description: (data_key.encrypted_keys)
+      returns:
+        - key: response
+          type: vault.DataKey
+          unwrap: true
+          properties:
+            - key: Id
+              type: string
+              description: (data_key.id)
+            - key: Key
+              type: string
+              description: (data_key.key)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/vault/key/decrypt-data-key.mdx
+---
+
+## Decrypt a data key
+
+Decrypt a data key that was previously encrypted using WorkOS Vault.
+
+<CodeBlock referenceId="decrypt_data_key">
+  <CodeBlockTab title="Request" file="decrypt-data-key-request" />
+  <CodeBlockTab title="Response" file="decrypt-data-key-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx

@@ -0,0 +1,52 @@
+---
+reference:
+  js:
+    - key: decrypt
+      id: decrypt_data
+      url: /reference/vault/key/decrypt-data
+      title: vault.decrypt()
+      parameters:
+        - key: encryptedData
+          type: string
+          description: (data_encryption.ciphertext)
+        - key: associatedData
+          type: string
+          optional: true
+          description: (data_encryption.aad)
+      returns:
+        - key: data
+          type: string
+          description: (data_encryption.plaintext)
+  go:
+    - key: Decrypt
+      id: decrypt_data
+      url: /reference/vault/key/decrypt-data
+      title: vault.Decrypt()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.DecryptOpts
+          expanded: true
+          properties:
+            - key: Data
+              type: string
+              description: (data_encryption.ciphertext)
+            - key: AssociatedData
+              type: string
+              optional: true
+              description: (data_encryption.aad)
+      returns:
+        - key: plaintext
+          type: string
+          description: (data_encryption.plaintext)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/key/decrypt-data.mdx
+---
+
+## Decrypt data
+
+Decrypt data that was previously encrypted with Vault. The data key in the ciphertext is decrypted using the Vault API and used to decrypt the remaining data. The decryption operations happen locally and neither the plaintext nor encrypted data are sent over the network.
+
+<CodeBlock referenceId="decrypt_data">
+  <CodeBlockTab title="Request" file="decrypt-data-request" />
+  <CodeBlockTab title="Response" file="decrypt-data-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx

@@ -0,0 +1,58 @@
+---
+reference:
+  js:
+    - key: encrypt
+      id: encrypt_data
+      url: /reference/vault/key/encrypt-data
+      title: vault.encrypt()
+      parameters:
+        - key: data
+          type: string
+          description: (data_encryption.plaintext)
+        - key: context
+          type: object
+          description: (object_metadata.context)
+        - key: associatedData
+          type: string
+          optional: true
+          description: (data_encryption.aad)
+      returns:
+        - key: encryptedData
+          type: string
+          description: (data_encryption.ciphertext)
+  go:
+    - key: Encrypt
+      id: encrypt_data
+      url: /reference/vault/key/encrypt-data
+      title: vault.Encrypt()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.EncryptOpts
+          expanded: true
+          properties:
+            - key: Data
+              type: string
+              description: (data_encryption.plaintext)
+            - key: KeyContext
+              type: vault.KeyContext
+              description: (object_metadata.context)
+            - key: AssociatedData
+              type: string
+              optional: true
+              description: (data_encryption.aad)
+      returns:
+        - key: ciphertext
+          type: string
+          description: (data_encryption.ciphertext)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/key/encrypt-data.mdx
+---
+
+## Encrypt data
+
+Perform a local encryption option. A data key is generated based on the provided key context and used to encrypt the data. The operation happens locally and neither the plaintext nor encrypted data are sent over the network.
+
+<CodeBlock referenceId="encrypt_data">
+  <CodeBlockTab title="Request" file="encrypt-data-request" />
+  <CodeBlockTab title="Response" file="encrypt-data-response" />
+</CodeBlock>

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

@@ -0,0 +1,25 @@
+---
+descriptions:
+  data_key:
+    id: Unique ID of the data key.
+    key: Base64 encoded data key that can be used for encryption operations.
+    encrypted_keys: >-
+      An encrypted data key. The data key is encrypted once with each key
+      identified from the key context and then Base64 encoded.
+  data_encryption:
+    plaintext: A blob of unencrypted data.
+    ciphertext: >-
+      An encrypted blob of data. The data key used to encrypt the data is
+      separately encrypted and encoded as part of the ciphertext.
+    aad: >-
+      Additional authenticated data used to authenticate the message and ensure
+      that it has not been tampered with. This optional parameter can be used to
+      bind the encrypted message to a given context, such as the row ID in a
+      database. If set during encryption, the same AAD must be used during
+      decryption or the operation will fail.
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/key/index.mdx
+---
+
+# Encryption Key Management
+
+The key management APIs can be used to generate isolated encryption keys for local encryption and decryption operations.