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

# List passkey behaviour for a user cohort

> Returns a raw (non-aggregated) per-user list of passkey behaviour for a cohort of confirmed users defined by creation time window (fromMs/toMs) and capped at maxGroupSize. Each entry carries the user's passkeys plus compact passkey login/enrollment outcome summaries, so the caller can categorise passkey enablement client-side. Scoped to the project of the bearer token.

Required API key permission: `observe:passkeys:read`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml post /observe/passkeyCohort
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: Annotation APIs (dated notes for analytics context)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID)
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/passkeyCohort:
    post:
      tags:
        - ObservePasskey
      summary: List passkey behaviour for a user cohort
      description: >-
        Returns a raw (non-aggregated) per-user list of passkey behaviour for a
        cohort of confirmed users defined by creation time window (fromMs/toMs)
        and capped at maxGroupSize. Each entry carries the user's passkeys plus
        compact passkey login/enrollment outcome summaries, so the caller can
        categorise passkey enablement client-side. Scoped to the project of the
        bearer token.


        Required API key permission: `observe:passkeys:read`.
      operationId: ObservePasskeyCohortList
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/observePasskeyCohortReq'
      responses:
        '200':
          description: Per-user passkey behaviour list for the cohort
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/observePasskeyCohortUser'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:passkeys:read
components:
  schemas:
    observePasskeyCohortReq:
      type: object
      required:
        - fromMs
        - toMs
        - maxGroupSize
      properties:
        authenticatorClass:
          type: string
          enum:
            - security-key
            - synced-passkey
            - device-bound-passkey
            - unknown
          description: >-
            Optional credential-class filter, applied after the user limit.
            Returns matching holders and credentials from the capped user
            cohort; matching holders outside that cohort are omitted. Activity
            includes only subflows linked to those credentials; unlinked
            attempts and enrollment-flow summaries are excluded. Omit for the
            existing all-credentials user cohort.
          x-oapi-codegen-extra-tags:
            validate: >-
              omitempty,oneof=security-key synced-passkey device-bound-passkey
              unknown
        fromMs:
          type: integer
          format: int64
          description: >-
            Cohort lower bound — users created at or after this epoch-ms
            timestamp
        toMs:
          type: integer
          format: int64
          description: >-
            Cohort upper bound — users created strictly before this epoch-ms
            timestamp
        maxGroupSize:
          type: integer
          description: Maximum number of users to return (newest first)
          x-oapi-codegen-extra-tags:
            validate: required,min=1,max=50000
    observePasskeyCohortUser:
      type: object
      required:
        - userID
        - createdMs
        - passkeys
        - passkeyLogin
        - passkeyEnrollment
        - passkeyEnrollmentFlow
      properties:
        userID:
          type: string
        externalID:
          type: string
        createdMs:
          type: integer
          format: int64
        passkeys:
          type: array
          items:
            $ref: '#/components/schemas/observePasskeyCohortPasskey'
        passkeyLogin:
          $ref: '#/components/schemas/observePasskeyCohortSubflowSummary'
        passkeyEnrollment:
          $ref: '#/components/schemas/observePasskeyCohortSubflowSummary'
        passkeyEnrollmentFlow:
          $ref: '#/components/schemas/observePasskeyCohortEnrollmentFlowSummary'
    observePasskeyCohortPasskey:
      type: object
      required:
        - credentialID
        - dataStatus
        - transports
        - backupState
        - createdMs
      properties:
        type:
          type: string
          description: Credential type stored by Observe, when classified.
          enum:
            - passkey
            - hardware-security-key
            - non-discoverable-key
            - u2f-key
        authenticatorClass:
          type: string
          enum:
            - security-key
            - synced-passkey
            - device-bound-passkey
            - unknown
          description: >-
            Class derived from stored credential type, roaming transports and
            backup state. Unknown means insufficient evidence, not absence from
            MDS.
        credentialID:
          type: string
          description: base64url-encoded credential ID
        dataStatus:
          type: string
          description: pre-registered | full-observed | full-patched | partial-login
        aaguid:
          type:
            - string
            - 'null'
          x-omitempty: false
        aaguidStatus:
          type:
            - string
            - 'null'
          x-omitempty: false
        transports:
          type: array
          items:
            type: string
        backupState:
          type: boolean
        createdMs:
          type: integer
          format: int64
    observePasskeyCohortSubflowSummary:
      type: object
      required:
        - total
        - completed
        - errored
      properties:
        total:
          type: integer
          description: Number of subflows of this type for the user
        completed:
          type: integer
          description: Number that completed successfully
        errored:
          type: integer
          description: Number that had at least one error
        firstCompletedMs:
          type:
            - integer
            - 'null'
          format: int64
          x-omitempty: false
          description: >-
            Epoch-ms of the user's first successful subflow of this type
            (activation marker for login)
    observePasskeyCohortEnrollmentFlowSummary:
      type: object
      required:
        - complete
        - skipped
        - invisible
      properties:
        complete:
          type: integer
          description: >-
            Number of the user's enrollment flows that completed (a passkey was
            created)
        skipped:
          type: integer
          description: >
            Number of enrollment flows the user was offered and explicitly
            skipped (explicitOutcome=skipped). Separates "offered but declined
            self-registration" from "never eligible".
        invisible:
          type: integer
          description: >-
            Number of enrollment flows that were denied by the system
            (explicitOutcome=invisible — already-enrolled or not-eligible)
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an Observe API key from the management console. The key selects the
        project and must grant the permission listed on the operation. Keep this
        key on your server.

````