@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/get-logout-url.mdx

@@ -3,7 +3,7 @@ reference:
   js:
     - key: getLogOutUrl
       id: get_logout_url_session_helpers
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.getLogOutUrl()
       returns:
         - key: logOutUrl
@@ -12,7 +12,7 @@ reference:
   ruby:
     - key: get_logout_url
       id: get_logout_url_session_helpers
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.get_logout_url()
       returns:
         - key: log_out_url
@@ -21,19 +21,19 @@ reference:
   python:
     - key: get_logout_url
       id: get_logout_url_session_helpers
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.get_logout_url()
       returns:
         - key: log_out_url
           type: string
           description: The URL to direct a user to for logging out.
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/get-logout-url.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-helpers/get-logout-url.mdx
 ---
 
 ## Get log out URL
 
-End a user’s session. The user’s browser should be redirected to this URL. Functionally similar to [Get logout URL](/reference/user-management/logout/get-logout-url) but extracts the session ID automatically from the session data.
+End a user’s session. The user’s browser should be redirected to this URL. Functionally similar to [Get logout URL](/reference/authkit/logout/get-logout-url) but extracts the session ID automatically from the session data.
 
 <CodeBlock
   referenceId="get_logout_url_session_helpers"

package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/index.mdx

@@ -6,9 +6,9 @@ description:
       Password used to unseal the session cookie. Must be the same as the
       password used to seal the cookie.
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/index.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-helpers/index.mdx
 ---
 
 # Session helpers
 
-After authenticating and [storing the encrypted session as a cookie](/user-management/vanilla/nodejs/3-handle-the-user-session/save-the-encrypted-session), retrieving and decrypting the session is made easy via the session helper methods.
+After authenticating and [storing the encrypted session as a cookie](/authkit/vanilla/nodejs/3-handle-the-user-session/save-the-encrypted-session), retrieving and decrypting the session is made easy via the session helper methods.

package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/load-sealed-session.mdx

@@ -3,7 +3,7 @@ reference:
   js:
     - key: loadSealedSession
       id: load_sealed_session
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: userManagement.loadSealedSession()
       parameters:
         - key: options
@@ -33,7 +33,7 @@ reference:
   ruby:
     - key: load_sealed_session
       id: load_sealed_session
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: UserManagement.load_sealed_session()
       parameters:
         - key: options
@@ -63,7 +63,7 @@ reference:
   python:
     - key: load_sealed_session
       id: load_sealed_session
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: user_management.load_sealed_session()
       parameters:
         - key: options
@@ -91,7 +91,7 @@ reference:
               type: function
               description: Returns the log out URL
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/load-sealed-session.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-helpers/load-sealed-session.mdx
 ---
 
 ## Load sealed session

package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/refresh.mdx

@@ -3,7 +3,7 @@ reference:
   js:
     - key: refresh
       id: refresh
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.refresh()
       parameters:
         - key: options
@@ -52,7 +52,11 @@ reference:
             - key: role
               type: string
               optional: true
-              description: The role of the user.
+              description: (access_token.role)
+            - key: roles
+              type: array
+              optional: true
+              description: (access_token.roles)
             - key: permissions
               optional: true
               type: array
@@ -61,6 +65,10 @@ reference:
               optional: true
               type: array
               description: The entitlements of the user.
+            - key: featureFlags
+              optional: true
+              type: array
+              description: The feature flags of the user.
             - key: impersonator
               type: object
               optional: true
@@ -81,7 +89,7 @@ reference:
   ruby:
     - key: refresh
       id: refresh
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.refresh()
       parameters:
         - key: options
@@ -126,7 +134,7 @@ reference:
   python:
     - key: refresh
       id: refresh
-      url: /reference/user-management/session-helpers
+      url: /reference/authkit/session-helpers
       title: session.refresh()
       parameters:
         - key: options
@@ -172,7 +180,11 @@ reference:
             - key: role
               type: string
               optional: true
-              description: The role of the user.
+              description: (access_token.role)
+            - key: roles
+              type: array
+              optional: true
+              description: (access_token.roles)
             - key: permissions
               optional: true
               type: array
@@ -199,7 +211,7 @@ reference:
                 The reason the session failed to refresh. Only present if
                 `authenticated = false`.
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-helpers/refresh.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-helpers/refresh.mdx
 ---
 
 ## Refresh

package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/access-token.mdx

@@ -3,22 +3,27 @@ descriptions:
   access_token:
     permissions: >-
       The slugs of the permissions assigned on the [organization
-      membership](/reference/user-management/organization-membership) via the
-      role.
+      membership](/reference/authkit/organization-membership) via the role.
     entitlements: >
       The lookup keys of the Stripe entitlements available to the user’s
       [Organization](/reference/organization).
     role: >-
       Corresponds to the role on the [organization
-      membership](/reference/user-management/organization-membership)
+      membership](/reference/authkit/organization-membership). If multiple roles
+      are assigned to the user, this will be the highest priority role based on
+      the order defined in the [priority
+      order](/rbac/configuration/configure-roles/priority-order).
+    roles: >-
+      An array of all roles assigned to the user via the [organization
+      membership](/reference/authkit/organization-membership).
     session_id: >-
       The session ID. You would use this with the [logout
-      endpoint](/reference/user-management/logout).
+      endpoint](/reference/authkit/logout).
 reference:
   json:
     - key: access_token
       id: access_token
-      url: /reference/user-management/session-tokens/access-token
+      url: /reference/authkit/session-tokens/access-token
       title: Access Token JWT
       properties:
         - key: iss
@@ -37,7 +42,7 @@ reference:
             compatible claim
 
             present when the session was started using
-            [impersonation](/user-management/impersonation).
+            [impersonation](/authkit/impersonation).
 
 
             The nested `sub` claim contains the email adddress of the WorkOS
@@ -51,6 +56,9 @@ reference:
         - key: role
           type: string
           description: (access_token.role)
+        - key: roles
+          type: array
+          description: (access_token.roles)
         - key: permissions
           type: 'string[]'
           description: (access_token.permissions)
@@ -76,12 +84,12 @@ reference:
             The token was issued at this time. The timestamp is the number of
             seconds since epoch.
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/access-token.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-tokens/access-token.mdx
 ---
 
 ## Access token
 
-The access token that is returned in successful authentication responses is a JWT that can be used to verify that a user has an active session. The JWT is signed by a JWKS which can be retrieved from the [WorkOS API](/reference/user-management/session-tokens/jwks).
+The access token that is returned in successful authentication responses is a JWT that can be used to verify that a user has an active session. The JWT is signed by a JWKS which can be retrieved from the [WorkOS API](/reference/authkit/session-tokens/jwks).
 
 <CodeBlock
   title="Decoded access token"

package/.docs/organized/docs/reference/authkit/session-tokens/index.mdx

@@ -0,0 +1,5 @@
+---
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-tokens/index.mdx
+---
+# Session tokens

package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/jwks.mdx

@@ -6,7 +6,7 @@ reference:
   curl:
     - key: getJwksUrl
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: /sso/jwks
       type: GET
       properties:
@@ -20,7 +20,7 @@ reference:
   js:
     - key: getJwksUrl
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: userManagement.getJwksUrl()
       parameters:
         - key: clientId
@@ -33,7 +33,7 @@ reference:
   go:
     - key: GetJwksUrl
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: usermanagement.GetJwksUrl()
       parameters:
         - key: ClientID
@@ -47,7 +47,7 @@ reference:
   ruby:
     - key: get_jwks_url
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: UserManagement.get_jwks_url()
       parameters:
         - key: client_id
@@ -60,7 +60,7 @@ reference:
   java:
     - key: getJwksUrl
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: userManagement.getJwksUrl()
       parameters:
         - key: clientId
@@ -73,7 +73,7 @@ reference:
   php:
     - key: getJwksUrl
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: $userManagement->getJwksUrl()
       parameters:
         - key: clientId
@@ -86,7 +86,7 @@ reference:
   python:
     - key: get_jwks_url
       id: get_jwks_url
-      url: /reference/user-management/session-tokens/jwks
+      url: /reference/authkit/session-tokens/jwks
       title: user_management.get_jwks_url()
       parameters:
         - key: client_id
@@ -97,7 +97,7 @@ reference:
           type: string
           description: (get_jwks_url.url)
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/jwks.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-tokens/jwks.mdx
 ---
 
 ## JWKS URL

package/.docs/organized/docs/reference/authkit/session-tokens/refresh-token.mdx

@@ -0,0 +1,8 @@
+---
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/authkit/session-tokens/refresh-token.mdx
+---
+## Refresh token
+
+The refresh token can be used to obtain a new access token using the [authenticate with refresh token
+](/reference/authkit/authentication/refresh-token) endpoint. Refresh tokens may only be used once. Refreshes will succeed as long as the user's session is still active.

package/.docs/organized/docs/reference/{user-management → authkit}/user/create.mdx

@@ -8,7 +8,7 @@ descriptions:
     password_hash_type: >
       The algorithm originally used to hash the password, used when providing a
       `password_hash`. Valid values are `bcrypt`, `scrypt`, `firebase-scrypt`,
-      `ssha`, and `pbkdf2`.
+      `ssha`, `pbkdf2`, and `argon2`.
 
 
       See the [Firebase Migration guide](/migrate/firebase) for an example of
@@ -19,7 +19,7 @@ descriptions:
 
 
       You should normally use the [email verification
-      flow](/reference/user-management/authentication/email-verification)
+      flow](/reference/authkit/authentication/email-verification)
 
       to verify a user’s email address. However, if the user’s email was
       previously verified, or
@@ -29,16 +29,16 @@ descriptions:
 
       already verified.
     external_id: >-
-      The [external identifier](/user-management/metadata/external-identifiers)
-      of the user.
+      The [external identifier](/authkit/metadata/external-identifiers) of the
+      user.
     metadata: >-
-      Object containing [metadata](/user-management/metadata) key/value pairs
-      associated with the user.
+      Object containing [metadata](/authkit/metadata) key/value pairs associated
+      with the user.
 reference:
   curl:
     - key: create_user
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: /user_management/users
       type: POST
       parameters:
@@ -72,7 +72,7 @@ reference:
         - key: external_id
           type: string
           optional: true
-          description: (user.external_id)
+          description: (create_user.external_id)
         - key: metadata
           type: object
           optional: true
@@ -82,7 +82,7 @@ reference:
   js:
     - key: createUser
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: userManagement.createUser()
       parameters:
         - key: options
@@ -119,7 +119,7 @@ reference:
             - key: externalId
               type: string
               optional: true
-              description: (user.external_id)
+              description: (create_user.external_id)
             - key: metadata
               type: object
               optional: true
@@ -129,7 +129,7 @@ reference:
   go:
     - key: CreateUser
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: usermanagement.CreateUser()
       parameters:
         - (ctx)
@@ -164,6 +164,14 @@ reference:
               type: boolean
               optional: true
               description: (create_user.email_verified)
+            - key: ExternalID
+              type: string
+              optional: true
+              description: (create_user.external_id)
+            - key: Metadata
+              type: 'map[string]string'
+              optional: true
+              description: (create_user.metadata)
       returns:
         - key: user
           type: usermanagement.User
@@ -172,7 +180,7 @@ reference:
   php:
     - key: createUser
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: $userManagement->createUser()
       parameters:
         - key: email
@@ -207,7 +215,7 @@ reference:
   python:
     - key: create_user
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: user_management.create_user()
       parameters:
         - key: email
@@ -237,12 +245,20 @@ reference:
           type: bool
           optional: true
           description: (create_user.email_verified)
+        - key: external_id
+          type: str
+          optional: true
+          description: (user.external_id)
+        - key: metadata
+          type: 'Dict[str, str]'
+          optional: true
+          description: (user.metadata)
       returns:
         - (User)
   ruby:
     - key: create_user
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: UserManagement.create_user()
       parameters:
         - key: email
@@ -272,12 +288,16 @@ reference:
           type: Boolean
           optional: true
           description: (create_user.email_verified)
+        - key: external_id
+          type: str
+          optional: true
+          description: (create_user.external_id)
       returns:
         - (User)
   java:
     - key: createUser
       id: create_user
-      url: /reference/user-management/user/create
+      url: /reference/authkit/user/create
       title: userManagement.createUser()
       parameters:
         - key: options
@@ -313,8 +333,7 @@ reference:
               description: (create_user.email_verified)
       returns:
         - (User)
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/user/create.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/create.mdx
 ---
 
 ## Create a user

package/.docs/organized/docs/reference/{user-management → authkit}/user/delete.mdx

@@ -3,7 +3,7 @@ reference:
   curl:
     - key: delete_user
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: '/user_management/users/:id'
       type: DELETE
       parameters:
@@ -11,14 +11,14 @@ reference:
   js:
     - key: deleteUser
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: userManagement.deleteUser()
       parameters:
         - (User.id)
   php:
     - key: deleteUser
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: $userManagement->deleteUser()
       parameters:
         - key: id
@@ -27,7 +27,7 @@ reference:
   go:
     - key: DeleteUser
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: usermanagement.DeleteUser()
       parameters:
         - (ctx)
@@ -41,7 +41,7 @@ reference:
   python:
     - key: delete_user
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: user_management.delete_user()
       parameters:
         - key: user_id
@@ -50,7 +50,7 @@ reference:
   ruby:
     - key: delete_user
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: UserManagement.delete_user()
       parameters:
         - key: id
@@ -59,14 +59,13 @@ reference:
   java:
     - key: deleteUser
       id: delete_user
-      url: /reference/user-management/user/delete
+      url: /reference/authkit/user/delete
       title: userManagement.deleteUser()
       parameters:
         - key: userId
           type: String
           description: (user.id)
-originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/user/delete.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/delete.mdx
 ---
 
 ## Delete a user

package/.docs/organized/docs/reference/{user-management → authkit}/user/get-by-external-id.mdx

@@ -3,7 +3,7 @@ reference:
   curl:
     - key: get_user_by_external_id
       id: get_user_by_external_id
-      url: /reference/user-management/user/get-by-external-id
+      url: /reference/authkit/user/get-by-external-id
       title: '/user_management/users/external_id/:external_id'
       type: GET
       parameters:
@@ -16,7 +16,7 @@ reference:
     - key: getUserByExternalId
       patternBefore: userManagement.
       id: get_user_by_external_id
-      url: /reference/user-management/user/get-by-external-id
+      url: /reference/authkit/user/get-by-external-id
       title: userManagement.getUserByExternalId()
       type: GET
       parameters:
@@ -25,13 +25,25 @@ reference:
           description: (user.external_id)
       returns:
         - (User)
+  python:
+    - key: get_user_by_external_id
+      patternBefore: user_management.
+      id: get_user_by_external_id
+      url: /reference/authkit/user/get-by-external-id
+      title: user_management.get_user_by_external_id()
+      parameters:
+        - key: external_id
+          type: str
+          description: (user.external_id)
+      returns:
+        - (User)
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/user/get-by-external-id.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/user/get-by-external-id.mdx
 ---
 
 ## Get a user by external ID
 
-Get the details of an existing user by an [external identifier](/user-management/metadata/external-identifiers).
+Get the details of an existing user by an [external identifier](/authkit/metadata/external-identifiers).
 
 <CodeBlock referenceId="get_user_by_external_id">
   <CodeBlockTab title="Request" file="get-user-by-external-id-request" />

package/.docs/organized/docs/reference/{user-management → authkit}/user/get.mdx

@@ -3,7 +3,7 @@ reference:
   curl:
     - key: get_user
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: '/user_management/users/:id'
       type: GET
       parameters:
@@ -14,7 +14,7 @@ reference:
     - key: getUser
       patternBefore: userManagement.
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: userManagement.getUser()
       type: GET
       parameters:
@@ -25,7 +25,7 @@ reference:
     - key: GetUser
       patternBefore: usermanagement.
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: usermanagement.GetUser()
       parameters:
         - (ctx)
@@ -45,7 +45,7 @@ reference:
     - key: getUser
       patternBefore: userManagement->
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: $userManagement->getUser()
       type: GET
       parameters:
@@ -58,7 +58,7 @@ reference:
     - key: get_user
       patternBefore: user_management.
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: user_management.get_user()
       parameters:
         - key: user_id
@@ -69,7 +69,7 @@ reference:
   ruby:
     - key: get_user
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: UserManagement.get_user()
       type: GET
       parameters:
@@ -81,7 +81,7 @@ reference:
   java:
     - key: getUser
       id: get_user
-      url: /reference/user-management/user/get
+      url: /reference/authkit/user/get
       title: userManagement.getUser()
       type: GET
       parameters:
@@ -90,7 +90,7 @@ reference:
           description: (user.id)
       returns:
         - (User)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/user-management/user/get.mdx
+originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/get.mdx
 ---
 
 ## Get a user