DirectoryImportSummary

A request or response body; the type column links to the schemas it refers to.

DirectoryImportSummary

FieldTypeRequiredDescription
total_rowsintegeryes

Data rows in the file, not counting the header.

added_countintegeryes

Members added to the directory by this import.

skipped_countintegeryes

Rows skipped because their subject was already in the directory.

skipped_subjectsarray of stringyes

The file's subjects whose accounts were already in the directory, in file order; their existing accounts and profiles are untouched.

email_linked_countintegeryes

Email-only rows for which an account with a pending email link was created; always 0 unless allow_email_only was set.

skipped_emailsarray of stringyes

The file's email-only addresses whose accounts were already in the directory, in file order.

jsonExample
{
  "total_rows": 25,
  "added_count": 23,
  "skipped_count": 2,
  "skipped_subjects": [
    "auth0|507f1f77bcf86cd799439011"
  ],
  "email_linked_count": 0,
  "skipped_emails": []
}