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

# Log in

> Exchanges email and password for an access/refresh token pair.



## OpenAPI

````yaml /custos/openapi.yaml post /login
openapi: 3.1.0
info:
  title: Custos control-plane API
  version: 0.1.0
  description: >
    Seed specification. The auth, identity, key, host-list, and grant endpoints
    below are

    complete; the remaining control-plane endpoints are still being transcribed.
servers:
  - url: https://custos.example.com
    description: Your control plane
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Login, token refresh, and logout.
  - name: Identity
    description: The authenticated user.
  - name: Keys
    description: A user's SSH public keys.
  - name: Credentials
    description: Stored secrets, sealed at rest and audited on every read.
  - name: Permission requests
    description: Time-boxed access requests for gated credentials.
  - name: Sets
    description: >-
      Secret sets — an app's .env, either deployable (private) or team-shared
      (public).
  - name: Hosts
    description: Enrolled machines.
  - name: Health
    description: Liveness and readiness probes.
  - name: Notifications
    description: In-app notifications for the signed-in user.
  - name: Rotation reviews
    description: Credential rotation checklists raised when a user is suspended or removed.
  - name: Audit
    description: Install-wide trails.
  - name: Users
    description: Accounts and their lifecycle.
  - name: Invitations
    description: Onboarding new accounts.
  - name: Groups
    description: Resource groups — a grant on a group cascades to everything in it.
  - name: Grants
    description: Permission grants.
  - name: Enrollment
    description: Admitting a machine to the fleet. Daemon-facing.
  - name: Upgrades
    description: Rolling the daemon fleet forward.
paths:
  /login:
    post:
      tags:
        - Auth
      summary: Log in
      description: Exchanges email and password for an access/refresh token pair.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
                - password
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                client_public_key:
                  type: string
                  format: byte
                  description: >
                    The client's per-session X25519 public key, used to seal
                    responses. Required when the control plane runs with
                    CUSTOS_ENCRYPTION on.
      responses:
        '200':
          description: Token pair
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenPair'
        '401':
          description: Invalid credentials
        '429':
          description: Too many attempts; the account is temporarily throttled
      security: []
components:
  schemas:
    TokenPair:
      type: object
      properties:
        access_token:
          type: string
          description: Opaque; valid for 15 minutes.
        refresh_token:
          type: string
          description: Opaque; valid for 30 days and rotated on every use.
        expires_in:
          type: integer
          description: >
            Access-token lifetime in seconds, currently 900. A relative
            duration, not a timestamp — clients should add it to their own clock
            rather than trusting the server's.
          examples:
            - 900
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        An opaque access token from /login or /refresh. Tokens are checked
        against the database on every request, so revocation is immediate.

````

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