1Password Sign-In Attempts API

openapi: 3.2.0
info:
  title: 1Password Events Sign-In Attempts API
  description: The 1Password Events API provides programmatic access to event data generated within a 1Password account. It enables security teams and administrators to retrieve sign-in attempts, item usage records, and audit events for monitoring, compliance, and security analysis. The API uses cursor-based pagination with POST requests to efficiently stream large volumes of event data.
  version: 2.0.0
  contact:
    name: 1Password Support
    url: https://support.1password.com/
  termsOfService: https://1password.com/legal/terms-of-service/
servers:
- url: https://events.1password.com
  description: 1Password Events API server (US). Replace with the appropriate base URL for your 1Password account region.
security:
- bearerAuth: []
tags:
- name: Sign-In Attempts
  description: Retrieve information about sign-in attempts to 1Password accounts, including the name and IP address of the user who attempted to sign in, when the attempt was made, and for failed attempts the cause of failure.
paths:
  /api/v2/signinattempts:
    post:
      operationId: listSignInAttemptsV2
      summary: 1Password List Sign-in Attempts
      description: Returns information about sign-in attempts to 1Password accounts. Each record includes the name and IP address of the user who attempted to sign in, when the attempt was made, the type of sign-in, the country, and for failed attempts the cause of failure. The request must include either a cursor from a previous response or a ResetCursor object with a start time.
      tags:
      - Sign-In Attempts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventRequest'
      responses:
        '200':
          description: Successfully retrieved sign-in attempts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignInAttemptResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      description: Represents an error response from the Events API.
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
    SignInAttemptResponse:
      type: object
      description: The response containing sign-in attempt records and a cursor for pagination.
      properties:
        cursor:
          type: string
          description: A cursor to use in the next request to continue fetching events.
        has_more:
          type: boolean
          description: Whether there are more events available to fetch using the cursor.
        items:
          type: array
          description: The list of sign-in attempt records.
          items:
            $ref: '#/components/schemas/SignInAttempt'
    EventUser:
      type: object
      description: Represents a user involved in an event.
      properties:
        uuid:
          type: string
          format: uuid
          description: The unique identifier of the user.
        name:
          type: string
          description: The name of the user.
        email:
          type: string
          format: email
          description: The email address of the user.
    EventClient:
      type: object
      description: Information about the client application used in an event.
      properties:
        app_name:
          type: string
          description: The name of the 1Password application.
        app_version:
          type: string
          description: The version of the application.
        platform_name:
          type: string
          description: The name of the operating system platform.
        platform_version:
          type: string
          description: The version of the operating system.
        os_name:
          type: string
          description: The name of the operating system.
        os_version:
          type: string
          description: The version of the operating system.
        ip:
          type: string
          description: The IP address of the client.
    EventRequest:
      type: object
      description: The request body for fetching events. Must include either a cursor string from a previous response to continue pagination, or a ResetCursor object to start fetching from a specific time.
      properties:
        limit:
          type: integer
          description: The maximum number of event records to return per page.
          minimum: 1
          maximum: 1000
          default: 100
        cursor:
          type: string
          description: A cursor from a previous response to continue fetching events from where the last request left off.
        start_time:
          type: string
          format: date-time
          description: An ISO 8601 timestamp to begin fetching events from a specific time. Used to create a new cursor starting from this point.
    SignInAttempt:
      type: object
      description: Represents a single sign-in attempt to a 1Password account.
      properties:
        uuid:
          type: string
          format: uuid
          description: The unique identifier for the sign-in attempt.
        session_uuid:
          type: string
          format: uuid
          description: The UUID of the session associated with the sign-in attempt.
        timestamp:
          type: string
          format: date-time
          description: When the sign-in attempt occurred.
        category:
          type: string
          description: The category of the sign-in attempt.
          enum:
          - success
          - credentials_failed
          - mfa_failed
          - modern_version_required
          - sso_failed
        type:
          type: string
          description: The type of sign-in method used.
          enum:
          - credentials_ok
          - mfa_ok
          - password_secret_bad
          - mfa_missing
          - totp_disabled
          - totp_bad
          - u2f_failed
          - duo_failed
          - duo_native_failed
          - sso_failed
        country:
          type: string
          description: The two-letter ISO country code of the sign-in location.
          minLength: 2
          maxLength: 2
        target_user:
          $ref: '#/components/schemas/EventUser'
        client:
          $ref: '#/components/schemas/EventClient'
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Events API bearer token generated from 1Password. Each request must include this token in the Authorization header. The token must have the appropriate feature permissions for the endpoint being accessed.
externalDocs:
  description: 1Password Events API Reference
  url: https://developer.1password.com/docs/events-api/reference/