Skip to main content
POST
Search users by filter criteria

Authorizations

Authorization
string
header
required

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.

Body

application/json
userIDs
string[]

List of exact user IDs to search for (format tus-<number>). Mutually exclusive with other search fields.

userIDPattern
string

User ID pattern for prefix search (format tus-<number>%, e.g., "tus-123%" matches all user IDs starting with tus-123...). Mutually exclusive with other search fields.

externalIDs
string[]

List of exact external IDs to search for. Mutually exclusive with other search fields.

externalIDPattern
string

External ID pattern for prefix search, ending with '%' (e.g., "abc%" matches all external IDs starting with abc). Mutually exclusive with other search fields.

flowIDs
string[]

List of flow IDs to search for (e.g., "flw-123"). Returns the users owning those flows. Mutually exclusive with other search fields.

serialNumbers
string[]

List of exact YubiKey serial numbers. Returns the users owning a passkey with a matching serial number (pre-registered keys). Mutually exclusive with other search fields.

page
integer
default:1

Page number for pagination (1-based). Defaults to 1.

Required range: x >= 1
pageSize
integer
default:25

Number of items per page. Defaults to 25, maximum 1000.

Required range: 1 <= x <= 1000

Response

Users matching the search criterion, ordered by creation time (newest first).

id
string
required

User ID (format tus-<number>)

externalID
string
required

Customer-provided external ID

status
enum<string>
required

User status

Available options:
confirmed,
temporary
createdMs
integer<int64>
required

Creation time in milliseconds since epoch