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

# Sign in with local authentication



## OpenAPI

````yaml /api/openapi.yaml post /api/v1/auth/local/sign-in
openapi: 3.1.0
info:
  title: OpenCluster Control Plane API
  version: 0.1.0
  description: HTTP contract for the OpenCluster product API and inbound webhook endpoints.
  license:
    name: Apache-2.0
servers:
  - url: http://localhost:8080
    description: Local self-hosted deployment
security: []
tags:
  - name: Authentication
  - name: Organizations
  - name: Members
  - name: Sessions
  - name: Policy
  - name: Audit
  - name: Integration Types
  - name: Integrations
  - name: Relays
  - name: Incidents
  - name: Investigations
  - name: Conversations
  - name: Postmortems
  - name: Webhook Deliveries
  - name: Webhook Intake
  - name: Metadata
paths:
  /api/v1/auth/local/sign-in:
    post:
      tags:
        - Authentication
      summary: Sign in with local authentication
      operationId: signInLocal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocalSignInRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/SignIn'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
components:
  schemas:
    LocalSignInRequest:
      type: object
      additionalProperties: false
      required:
        - organization
        - email
        - password
      properties:
        organization:
          $ref: '#/components/schemas/OrganizationID'
        email:
          type: string
          format: email
          maxLength: 254
          example: operator@example.invalid
        password:
          type: string
          format: password
          minLength: 12
          maxLength: 1024
          writeOnly: true
          example: correct-horse-placeholder
    OrganizationID:
      type: string
      pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
      minLength: 1
      maxLength: 63
    SignInResult:
      type: object
      additionalProperties: false
      required:
        - signedIn
      properties:
        signedIn:
          type: boolean
          const: true
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
          minLength: 1
          maxLength: 1024
          example: the selected Organization is not available to this caller
        reason:
          type: string
          enum:
            - credential_rejected
            - session_expired
            - session_revoked
        requires:
          type: string
          minLength: 1
          maxLength: 128
  responses:
    SignIn:
      description: Sign-in succeeded and the session cookie was issued.
      headers:
        Set-Cookie:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SignInResult'
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or rejected credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: A bounded concurrency or request limit was reached.
      headers:
        Retry-After:
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'

````