@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/authkit/api-keys/index.mdx

@@ -0,0 +1,275 @@
+---
+descriptions:
+  api_key:
+    self: 'The corresponding [API key](/reference/authkit/api-keys) object.'
+    object: Distinguishes the API key object.
+    id: The unique ID of the API key.
+    owner:
+      self: The owner of the API key (organization).
+      type: 'The type of owner (e.g., "organization").'
+      id: The ID of the owner.
+    name: The human-readable name assigned to the API key.
+    obfuscated_value: >-
+      The obfuscated API key value showing only prefix and last few characters
+      for security.
+    permissions: >-
+      Array of permission strings assigned to this API key for authorization
+      purposes.
+    created_at: The timestamp when the API key was created.
+    updated_at: The timestamp when the API key was last updated.
+    last_used_at: 'The timestamp when the API key was last used, null if never used.'
+  api_keys:
+    validate: >-
+      Validates an API key and returns associated metadata for authentication
+      and authorization.
+reference:
+  curl:
+    - url: /reference/authkit/api-keys
+      key: api_key
+      id: api_key
+      title: api_key
+      properties:
+        - key: object
+          type: '"api_key"'
+          description: (api_key.object)
+        - key: id
+          type: string
+          description: (api_key.id)
+        - key: owner
+          type: object
+          description: (api_key.owner.self)
+          properties:
+            - key: type
+              type: string
+              description: (api_key.owner.type)
+            - key: id
+              type: string
+              description: (api_key.owner.id)
+        - key: name
+          type: string
+          description: (api_key.name)
+        - key: obfuscated_value
+          type: string
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: array
+          description: (api_key.permissions)
+        - key: created_at
+          type: string
+          description: (api_key.created_at)
+        - key: updated_at
+          type: string
+          description: (api_key.updated_at)
+        - key: last_used_at
+          optional: true
+          type: string
+          description: (api_key.last_used_at)
+  js:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: interface ApiKey
+      properties:
+        - key: object
+          type: '"api_key"'
+          description: (api_key.object)
+        - key: id
+          type: string
+          description: (api_key.id)
+        - key: owner
+          type: object
+          description: (api_key.owner.self)
+          properties:
+            - key: type
+              type: string
+              description: (api_key.owner.type)
+            - key: id
+              type: string
+              description: (api_key.owner.id)
+        - key: name
+          type: string
+          description: (api_key.name)
+        - key: obfuscatedValue
+          type: string
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: 'string[]'
+          description: (api_key.permissions)
+        - key: createdAt
+          type: string
+          description: (api_key.created_at)
+        - key: updatedAt
+          type: string
+          description: (api_key.updated_at)
+        - key: lastUsedAt
+          optional: true
+          type: string
+          description: (api_key.last_used_at)
+  go:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: usermanagement.ApiKey
+      properties:
+        - key: ID
+          type: string
+          description: (api_key.id)
+        - key: Owner
+          type: object
+          description: (api_key.owner)
+        - key: Name
+          type: string
+          description: (api_key.name)
+        - key: ObfuscatedValue
+          type: string
+          description: (api_key.obfuscated_value)
+        - key: Permissions
+          type: '[]string'
+          description: (api_key.permissions)
+        - key: CreatedAt
+          type: string
+          description: (api_key.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (api_key.updated_at)
+        - key: LastUsedAt
+          optional: true
+          type: string
+          description: (api_key.last_used_at)
+  php:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: WorkOS\Resource\ApiKey
+      properties:
+        - key: object
+          type: '"api_key"'
+          description: (api_key.object)
+        - key: id
+          type: string
+          description: (api_key.id)
+        - key: owner
+          type: object
+          description: (api_key.owner)
+        - key: name
+          type: string
+          description: (api_key.name)
+        - key: obfuscatedValue
+          type: string
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: array
+          description: (api_key.permissions)
+        - key: createdAt
+          type: string
+          description: (api_key.created_at)
+        - key: updatedAt
+          type: string
+          description: (api_key.updated_at)
+        - key: lastUsedAt
+          optional: true
+          type: string
+          description: (api_key.last_used_at)
+  python:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: ApiKey
+      properties:
+        - key: id
+          type: str
+          description: (api_key.id)
+        - key: owner
+          type: dict
+          description: (api_key.owner)
+        - key: name
+          type: str
+          description: (api_key.name)
+        - key: obfuscated_value
+          type: str
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: 'list[str]'
+          description: (api_key.permissions)
+        - key: created_at
+          type: str
+          description: (api_key.created_at)
+        - key: updated_at
+          type: str
+          description: (api_key.updated_at)
+        - key: last_used_at
+          optional: true
+          type: str
+          description: (api_key.last_used_at)
+  ruby:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: class ApiKey
+      properties:
+        - key: id
+          type: String
+          description: (api_key.id)
+        - key: owner
+          type: Hash
+          description: (api_key.owner)
+        - key: name
+          type: String
+          description: (api_key.name)
+        - key: obfuscated_value
+          type: String
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: Array
+          description: (api_key.permissions)
+        - key: created_at
+          type: String
+          description: (api_key.created_at)
+        - key: updated_at
+          type: String
+          description: (api_key.updated_at)
+        - key: last_used_at
+          optional: true
+          type: String
+          description: (api_key.last_used_at)
+  java:
+    - url: /reference/authkit/api-keys
+      key: ApiKey
+      id: api_key
+      title: class ApiKey
+      properties:
+        - key: id
+          type: String
+          description: (api_key.id)
+        - key: owner
+          type: Object
+          description: (api_key.owner)
+        - key: name
+          type: String
+          description: (api_key.name)
+        - key: obfuscatedValue
+          type: String
+          description: (api_key.obfuscated_value)
+        - key: permissions
+          type: 'String[]'
+          description: (api_key.permissions)
+        - key: createdAt
+          type: String
+          description: (api_key.created_at)
+        - key: updatedAt
+          type: String
+          description: (api_key.updated_at)
+        - key: lastUsedAt
+          optional: true
+          type: String
+          description: (api_key.last_used_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/api-keys/index.mdx
+---
+
+# API Keys
+
+API keys provide a secure way for your application's users to authenticate with your API. Organization admins create API keys through the [API Keys Widget](/widgets/api-keys), and your application can validate these keys to authenticate API requests.
+
+Read more about [API keys in AuthKit](/authkit/api-keys).
+
+<CodeBlock title="API Key" referenceId="api_key" file="api-key" />

package/.docs/organized/docs/reference/authkit/api-keys/list-for-organization.mdx

@@ -0,0 +1,41 @@
+---
+descriptions:
+  list_organization_api_keys:
+    data: 'Array of [API keys](/reference/authkit/api-keys).'
+reference:
+  curl:
+    - key: list_organization_api_keys
+      id: list_organization_api_keys
+      url: /reference/authkit/api-keys/list-for-organization
+      title: '/organizations/:id/api_keys'
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_organization_api_keys.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/authkit/api-keys/list-for-organization.mdx
+---
+
+## List organization API keys
+
+Get a list of all API keys for the provided organization.
+
+<CodeBlock referenceId="list_organization_api_keys">
+  <CodeBlockTab title="Request" file="list-organization-api-keys" />
+  <CodeBlockTab title="Response" file="list-organization-api-keys-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/authkit/api-keys/validate.mdx

@@ -0,0 +1,77 @@
+---
+title: Validate API key
+description: Validate an API key and retrieve associated metadata.
+descriptions:
+  validate_api_key:
+    value: The API key value to validate.
+  validate_api_key_response:
+    api_key: 'The API key object if valid, null otherwise.'
+    id: The unique identifier for the API key.
+    owner: The owner of the API key (organization).
+    name: The human-readable name assigned to the API key.
+    obfuscated_value: The obfuscated API key value showing only prefix and last few characters.
+    created_at: The timestamp when the API key was created.
+    updated_at: The timestamp when the API key was last updated.
+    last_used_at: 'The timestamp when the API key was last used, null if never used.'
+    permissions: Array of permission strings assigned to this API key.
+reference:
+  curl:
+    - key: validate-api-key
+      id: validate_api_key_request
+      url: /reference/authkit/api-keys/validate
+      title: /api_keys/validations
+      type: POST
+      parameters:
+        - key: value
+          type: string
+          description: (validate_api_key.value)
+      returns:
+        - key: api_key
+          type: object | null
+          description: (validate_api_key_response.api_key)
+          properties:
+            - key: id
+              type: string
+              description: (validate_api_key_response.id)
+            - key: owner
+              type: object
+              description: (validate_api_key_response.owner)
+              properties:
+                - key: type
+                  type: string
+                  description: 'The type of owner (e.g., "organization")'
+                - key: id
+                  type: string
+                  description: The ID of the owner
+            - key: name
+              type: string
+              description: (validate_api_key_response.name)
+            - key: obfuscated_value
+              type: string
+              description: (validate_api_key_response.obfuscated_value)
+            - key: created_at
+              type: string
+              description: (validate_api_key_response.created_at)
+            - key: updated_at
+              type: string
+              description: (validate_api_key_response.updated_at)
+            - key: last_used_at
+              type: string | null
+              description: (validate_api_key_response.last_used_at)
+            - key: permissions
+              type: array
+              description: (validate_api_key_response.permissions)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/authkit/api-keys/validate.mdx
+---
+
+## Validate API key
+
+Validates an API key and returns its associated metadata if the key is valid. Your application's API uses this endpoint to authenticate incoming requests that include an API key.
+
+The endpoint returns the complete API key object when validation succeeds, allowing you to access the key's permissions and owner information for authorization purposes. If the key is invalid, the endpoint returns `null` for the `api_key` field.
+
+<CodeBlock referenceId="validate_api_key_request">
+  <CodeBlockTab title="Request" file="validate-request" />
+  <CodeBlockTab title="Response" file="validate-response" />
+</CodeBlock>

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

@@ -4,28 +4,32 @@ descriptions:
     code: >-
       The authorization value which was passed back as a query parameter in the
       callback to the [redirect
-      URI](/reference/user-management/authentication/get-authorization-url/redirect-uri).
+      URI](/reference/authkit/authentication/get-authorization-url/redirect-uri).
     impersonator:
       email: >
         The email address of the WorkOS Dashboard user who is impersonating the
         user. Read
 
-        more about how impersonation works
-        [here](/user-management/impersonation).
+        more about how impersonation works [here](/authkit/impersonation).
       reason: The justification the impersonator gave for impersonating the user.
     code_verifier: >
       The randomly generated string used to derive the code challenge that was
       passed to the [authorization
-      url](/reference/user-management/authentication/get-authorization-url) as
-      part of the PKCE flow.
+      url](/reference/authkit/authentication/get-authorization-url) as part of
+      the PKCE flow.
 
 
       This parameter is **required** when the client secret is not present.
+    oauth_tokens:
+      access_token: The access token from the OAuth provider.
+      refresh_token: The refresh token from the OAuth provider.
+      expires_at: The timestamp at which the access token expires.
+      scopes: A list of OAuth scopes for which the access token is authorized.
 reference:
   curl:
     - key: oauth-sso
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: /user_management/authenticate
       type: POST
       parameters:
@@ -80,8 +84,8 @@ reference:
               optional: false
               description: >
                 [Exchange this
-                token](/reference/user-management/authentication/refresh-token)
-                for a new access token.
+                token](/reference/authkit/authentication/refresh-token) for a
+                new access token.
             - key: authentication_method
               type: >-
                 "SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
@@ -99,10 +103,26 @@ reference:
                   type: string
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: oauth_tokens
+              type: object
+              optional: true
+              properties:
+                - key: access_token
+                  type: string
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refresh_token
+                  type: string
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expires_at
+                  type: int
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: array
+                  description: (authentication.oauth_tokens.scopes)
   js:
     - key: authenticateWithCode
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: userManagement.authenticateWithCode()
       parameters:
         - key: options
@@ -165,8 +185,8 @@ reference:
               optional: false
               description: >
                 [Exchange this
-                token](/reference/user-management/authentication/refresh-token)
-                for new access tokens.
+                token](/reference/authkit/authentication/refresh-token) for new
+                access tokens.
             - key: authenticationMethod
               type: >-
                 "SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
@@ -188,15 +208,35 @@ reference:
               type: string
               optional: true
               description: (authentication.sealed_session)
+            - key: oauthTokens
+              type: object
+              optional: true
+              properties:
+                - key: accessToken
+                  type: string
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refreshToken
+                  type: string
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expiresAt
+                  type: number
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: array
+                  description: (authentication.oauth_tokens.scopes)
   python:
     - key: authenticate_with_code
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: user_management.authenticate_with_code()
       parameters:
         - key: code
           type: str
           description: (authentication.code)
+        - key: invitation_token
+          type: str
+          optional: true
+          description: (authentication.invitation_token)
         - key: ip_address
           type: str
           optional: true
@@ -236,10 +276,26 @@ reference:
                   type: str
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: oauth_tokens
+              type: OAuthTokens
+              optional: true
+              properties:
+                - key: access_token
+                  type: str
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refresh_token
+                  type: str
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expires_at
+                  type: int
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: 'Sequence[str]'
+                  description: (authentication.oauth_tokens.scopes)
   go:
     - key: AuthenticateWithCode
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: usermanagement.AuthenticateWithCode()
       parameters:
         - (ctx)
@@ -284,11 +340,27 @@ reference:
                   type: string
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: OAuthTokens
+              type: OAuthTokens
+              optional: true
+              properties:
+                - key: AccessToken
+                  type: string
+                  description: (authentication.oauth_tokens.access_token)
+                - key: RefreshToken
+                  type: string
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: ExpiresAt
+                  type: int
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: Scopes
+                  type: '[]string'
+                  description: (authentication.oauth_tokens.scopes)
         - (err)
   php:
     - key: authenticateWithCode
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: $userManagement->authenticateWithCode()
       parameters:
         - key: clientID
@@ -328,10 +400,26 @@ reference:
                   type: string
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: oauthTokens
+              type: OAuthTokens
+              optional: true
+              properties:
+                - key: accessToken
+                  type: string
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refreshToken
+                  type: string
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expiresAt
+                  type: int
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: array
+                  description: (authentication.oauth_tokens.scopes)
   ruby:
     - key: authenticate_with_code
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: UserManagement.authenticate_with_code()
       parameters:
         - key: client_id
@@ -371,10 +459,26 @@ reference:
                   type: String
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: oauth_tokens
+              type: OAuthTokens
+              optional: true
+              properties:
+                - key: access_token
+                  type: String
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refresh_token
+                  type: String
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expires_at
+                  type: Integer
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: 'Array[String]'
+                  description: (authentication.oauth_tokens.scopes)
   java:
     - key: authenticateWithCode
       id: authenticate_with_code
-      url: /reference/user-management/authentication/code
+      url: /reference/authkit/authentication/code
       title: userManagement.authenticateWithCode()
       parameters:
         - key: clientId
@@ -432,15 +536,31 @@ reference:
                   type: String
                   optional: true
                   description: (authentication.impersonator.reason)
+            - key: oauthTokens
+              type: OAuthTokens
+              optional: true
+              properties:
+                - key: accessToken
+                  type: String
+                  description: (authentication.oauth_tokens.access_token)
+                - key: refreshToken
+                  type: String
+                  description: (authentication.oauth_tokens.refresh_token)
+                - key: expiresAt
+                  type: Long
+                  description: (authentication.oauth_tokens.expires_at)
+                - key: scopes
+                  type: List<String>
+                  description: (authentication.oauth_tokens.scopes)
 originalPath: >-
-  .tmp-workos-clone/packages/docs/content/reference/user-management/authentication/code.mdx
+  .tmp-workos-clone/packages/docs/content/reference/authkit/authentication/code.mdx
 ---
 
 ## Authenticate with code
 
 Authenticates a user using AuthKit, OAuth or an organization’s SSO connection.
 
-AuthKit handles all authentication methods, however it is conceptually similar to a social login experience. Like OAuth and SSO, AuthKit returns you a code that you can exchange for an authenticated user. See [Integrating with AuthKit](/user-management).
+AuthKit handles all authentication methods, however it is conceptually similar to a social login experience. Like OAuth and SSO, AuthKit returns you a code that you can exchange for an authenticated user. See [Integrating with AuthKit](/authkit).
 
 <CodeBlock referenceId="authenticate_with_code">
   <CodeBlockTab title="Request" file="authenticate-with-code-request" />