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
| Field | Type | What it is |
|---|---|---|
parent | string | The environment that owns the batch. Required. |
batch_id | string | The batch ID to read back. Required. |
page_size | int32 | At most this many records; default 50, clamped to 100. |
page_token | string | next_page_token of the previous page. |
Response
| Field | Type | What it is |
|---|---|---|
records | EndUserImportRecord[] | Admitted records in canonical source_id order. Fails closed if any admitted principal was erased or ciphertext is unreadable. |
batch_id | string | The admitted batch ID. |
next_page_token | string | Pass as page_token on the next call; empty at the end. |
EndUserImportRecord
| Field | Type | What it is |
|---|---|---|
source_id | string | Canonical source ID within the batch's key_namespace. |
principal_id | string | Admitted destination principal ID. |
input | EndUserImportInput | Exact canonical typed import input admitted for this principal. |
EndUserImportInput
| Field | Type | What it is |
|---|---|---|
external_ids | map<string, string> | Immutable source identifiers keyed by namespace; must contain the batch's key_namespace. Required. |
email | string | Optional email address for the imported end user. |
email_verified | bool | Whether email was already verified in the source system. |
phone | string | Optional E.164 phone number for the imported end user. |
phone_verified | bool | Whether phone was already verified in the source system. |
display_name | string | Optional human-readable display name for the end user. |
status | string | Account state (active or suspended); unspecified values are refused. Required. |
create_time | timestamp | Original source creation timestamp for the imported end user. Required. |
password | EndUserImportPassword | Optional existing password verifier for the end user. |
links | EndUserImportLink[] | Federated identity provider links held by the end user. |
devices | EndUserImportDevice[] | Device credentials bound to the end user. |
totp_secret_base32 | string | Optional Base32-encoded TOTP secret for MFA enrollment. Never returned again. |
EndUserImportPassword
| Field | Type | What it is |
|---|---|---|
format | string | Explicit existing verifier scheme: aspnet-identity-v2, aspnet-identity-v3, bcrypt, scrypt, argon2 or pbkdf2. Never inferred from the value. Required. |
value | string | Encoded password hash in the declared format. Required. Never returned again. |
EndUserImportLink
| Field | Type | What it is |
|---|---|---|
issuer | string | OIDC issuer URL identifying the external identity provider. Required. |
subject | string | Subject identifier assigned by the issuer. Required. |
EndUserImportDevice
| Field | Type | What it is |
|---|---|---|
id | string | Source device identifier unique to this device binding. Required. |
secret | string | Optional device secret; missing invokes existing weak-device rules. Never returned again. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
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"