โ† API reference
Query / admin

getUserBy

Fetch a user by external ID or email. Requires user:read permission.

Arguments

externalIdString

External system identifier

emailString

User email address

Returns UserState

Scalar fields at a glance

externalIdString
emailString!
nameString
createdAtString!
โ†— View the complete UserState type

Explore in a view

Administration and IAM
View exact SDL
"""Fetch a user by external ID or email. Requires user:read permission."""
getUserBy(
  """External system identifier"""
  externalId: String
  """User email address"""
  email: String
): UserState @topic(names: ["admin"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.