Skip to content
Console
On this page

List import records on an end user

Returns an admitted import batch in canonical source_id order, including sensitive verifier input.

Returns an admitted import batch in canonical source_id order, including sensitive verifier input.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users:listImportRecords
  • Scope auth:read
  • Effect read — nothing is written.
  • Collection end_users
  • Query batch_id, page_size, page_token

Request

FieldTypeWhat it is
parentstringThe environment that owns the batch. Required.
batch_idstringThe batch ID to read back. Required.
page_sizeint32At most this many records; default 50, clamped to 100.
page_tokenstringnext_page_token of the previous page.

Response

FieldTypeWhat it is
recordsEndUserImportRecord[]Admitted records in canonical source_id order. Fails closed if any admitted principal was erased or ciphertext is unreadable.
batch_idstringThe admitted batch ID.
next_page_tokenstringPass as page_token on the next call; empty at the end.

EndUserImportRecord

FieldTypeWhat it is
source_idstringCanonical source ID within the batch's key_namespace.
principal_idstringAdmitted destination principal ID.
inputEndUserImportInputExact canonical typed import input admitted for this principal.

EndUserImportInput

FieldTypeWhat it is
external_idsmap<string, string>Immutable source identifiers keyed by namespace; must contain the batch's key_namespace. Required.
emailstringOptional email address for the imported end user.
email_verifiedboolWhether email was already verified in the source system.
phonestringOptional E.164 phone number for the imported end user.
phone_verifiedboolWhether phone was already verified in the source system.
display_namestringOptional human-readable display name for the end user.
statusstringAccount state (active or suspended); unspecified values are refused. Required.
create_timetimestampOriginal source creation timestamp for the imported end user. Required.
passwordEndUserImportPasswordOptional existing password verifier for the end user.
linksEndUserImportLink[]Federated identity provider links held by the end user.
devicesEndUserImportDevice[]Device credentials bound to the end user.
totp_secret_base32stringOptional Base32-encoded TOTP secret for MFA enrollment. Never returned again.

EndUserImportPassword

FieldTypeWhat it is
formatstringExplicit existing verifier scheme: aspnet-identity-v2, aspnet-identity-v3, bcrypt, scrypt, argon2 or pbkdf2. Never inferred from the value. Required.
valuestringEncoded password hash in the declared format. Required. Never returned again.
FieldTypeWhat it is
issuerstringOIDC issuer URL identifying the external identity provider. Required.
subjectstringSubject identifier assigned by the issuer. Required.

EndUserImportDevice

FieldTypeWhat it is
idstringSource device identifier unique to this device binding. Required.
secretstringOptional device secret; missing invokes existing weak-device rules. Never returned again.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users:listImportRecords" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"