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

# List logins

> Retrieves all logins with optional filtering by name or username



## OpenAPI

````yaml post /logins/list
openapi: 3.1.0
info:
  title: Kaizen API
  version: 1.0.0
  description: API for the Kaizen Automation Platform
servers:
  - url: https://api.kaizenautomation.com
    description: Production server
security: []
paths:
  /logins/list:
    post:
      tags:
        - Logins
      summary: List logins
      description: Retrieves all logins with optional filtering by name or username
      requestBody:
        description: Request body for listing logins
        content:
          application/json:
            schema:
              type: object
              properties:
                search:
                  type: string
                  description: Search logins by name or username
              description: Request parameters for listing logins
      responses:
        '200':
          description: Logins retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  logins:
                    type: array
                    items:
                      $ref: '#/components/schemas/Object_id_organizationId_name_0'
                    description: List of logins matching the query parameters
                required:
                  - logins
                description: Response containing a list of logins and metadata
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
components:
  schemas:
    Object_id_organizationId_name_0:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the login
        organizationId:
          type: string
          description: ID of the organization that owns this login.
        name:
          type: string
          description: Name of the login
        authenticationUrl:
          type: string
          description: URL of the authentication page
        homeUrl:
          type: string
          description: URL of the home page
        iconUrl:
          type:
            - string
            - 'null'
          description: >-
            Icon URL or data URL for the login logo. Null if no custom logo is
            set.
        description:
          type:
            - string
            - 'null'
          description: >-
            Optional description/subheading for the login. Null if no
            description is set.
        loginConfiguration:
          $ref: '#/components/schemas/LoginConfiguration'
        createdAt:
          type: string
          description: Timestamp when the login was created
        updatedAt:
          type: string
          description: Timestamp when the login was last updated
        persistSession:
          type: boolean
          default: true
          description: Whether to persist the session after authentication
        isManualAuthentication:
          type: boolean
          default: false
          description: Whether this login requires manual authentication
        useLLMLoginDetection:
          type: boolean
          description: >-
            Whether to use LLM-powered login detection. If false, uses URL-based
            detection instead.
        loginDetectionPrompt:
          type: string
          description: >-
            Custom prompt to use for LLM-based login detection. Describes what
            the logged-out experience looks like.
        loginInstructionsPrompt:
          type: string
          description: >-
            Custom instructions for the login agent. Provides guidance on how to
            complete the login flow for this specific site.
        supportConcurrentLogins:
          type: boolean
          default: true
          description: >-
            Whether to allow concurrent logins using this login. When false, a
            lock is acquired before login to prevent simultaneous sessions.
        supportsAgentConcurrency:
          type: boolean
          default: false
          description: >-
            Whether this login supports concurrent usage by multiple agents.
            When false (default), only one agent can use this login at a time.
        autoRetryOnServiceDown:
          type: boolean
          default: false
          description: >-
            Whether to automatically retry scheduled executions when the target
            service appears to be down.
        autoRetryDelayMinutes:
          type: integer
          default: 30
          description: >-
            Number of minutes to wait before retrying when service down is
            detected.
        autoRetryMaxAttempts:
          type: integer
          default: 3
          description: Maximum number of service-down retry attempts before giving up.
      required:
        - id
        - organizationId
        - name
        - authenticationUrl
        - homeUrl
        - iconUrl
        - description
        - loginConfiguration
        - createdAt
        - updatedAt
        - persistSession
        - isManualAuthentication
        - supportConcurrentLogins
        - supportsAgentConcurrency
        - autoRetryOnServiceDown
        - autoRetryDelayMinutes
        - autoRetryMaxAttempts
    LoginConfiguration:
      type: object
      properties:
        username:
          type: string
          description: Username for authentication
        twoFactorAuthConfiguration:
          type:
            - object
            - 'null'
          properties:
            method:
              type: string
              enum:
                - Email
                - SMS
                - TOTP
              description: Method used for 2FA verification
            alwaysRequired:
              type: boolean
              description: >-
                Whether 2FA is always required, if it is not, the workflow will
                make a determination based upon the text displayed on the site.
            twoFactorAuthEmail:
              type: string
              description: >-
                The email which the 2FA codes will be sent to, which our system
                will use to associate to the created login. Required when method
                is Email.
          required:
            - method
            - alwaysRequired
          description: Configuration for two-factor authentication
        additionalCredentials:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the additional credential
              key:
                type: string
                description: Key for the additional credential
              value:
                type: string
                description: Value for the additional credential
            required:
              - key
              - value
          description: Additional key-value credentials
      description: >-
        Values for fields required to complete authentication. Sensitive
        credentials are excluded for security.

````