> ## Documentation Index
> Fetch the complete documentation index at: https://docs.server.express/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe the current credential and its scopes

> Who this credential is and what it may do. Accepts a browser session or an API token, with no particular scope required. A session reports every scope; a token reports its own. `admin` is true only for an ADMIN session, because admin routes never accept API tokens. This is informational — every route still enforces its own scope. Used by the MCP server to decide which tools to offer.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/auth/whoami
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/auth/whoami:
    get:
      tags:
        - Auth
      summary: Describe the current credential and its scopes
      description: >-
        Who this credential is and what it may do. Accepts a browser session or
        an API token, with no particular scope required. A session reports every
        scope; a token reports its own. `admin` is true only for an ADMIN
        session, because admin routes never accept API tokens. This is
        informational — every route still enforces its own scope. Used by the
        MCP server to decide which tools to offer.
      operationId: publicAuthWhoami
      responses:
        '200':
          description: The credential's identity and scopes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PublicAuthWhoami'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicAuthWhoami:
      allOf:
        - $ref: '#/components/schemas/PublicAuthMe'
        - type: object
          required:
            - credential
            - tokenName
            - scopes
            - admin
          properties:
            credential:
              type: string
              enum:
                - session
                - api_token
            tokenName:
              type:
                - string
                - 'null'
              description: The API token's name, or null for a session.
            scopes:
              type: array
              description: The token's scopes, or every scope for a session.
              items:
                type: string
                enum:
                  - services:read
                  - services:stats
                  - services:power
                  - services:rescue
                  - services:reinstall
                  - services:cancel
                  - snapshots:read
                  - snapshots:write
                  - catalogue:read
                  - orders:place
                  - invoices:read
                  - invoices:pay
                  - tickets:read
                  - tickets:write
            admin:
              type: boolean
              description: True only for an ADMIN signed in with a session.
    PublicAuthMe:
      type: object
      required:
        - id
        - email
        - firstName
        - lastName
        - role
        - emailVerified
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        firstName:
          type: string
        lastName:
          type: string
        role:
          type: string
          enum:
            - client
            - admin
        emailVerified:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.