DirectoryImportForm

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

DirectoryImportForm

Field	Type	Required	Description
provider_id	string	yes	Sign-in provider UUID id or slug; every row's user_id is the OIDC `sub` claim the member will present at this provider. at least 1 character
allow_email_only	string	no	Set true to accept rows with a blank (or absent) user_id and an email: each resolves to the account a pending email link or a single live profile email already names, or else creates an account with a pending email link at the provider, so that person's first sign-in there lands in it. Default false. one of "true" \| "false"
file	string (binary)	yes	CSV file, at most 1 MB: a header row naming a `user_id` (the OIDC `sub` claim at the named provider; `user_subject`, `subject` and `sub` are accepted too), `name` (or `display_name`) and `email` column in any order, then one member per row. Header matching is case-insensitive and extra columns are ignored. A member's name and email cells may be left blank; they seed a newly created account's profile. With `allow_email_only`, the user_id column may be blank or missing and rows are matched by email instead.

Field

Type

Required

Description

provider_id

string

yes

Sign-in provider UUID id or slug; every row's user_id is the OIDC `sub` claim the member will present at this provider.

at least 1 character

allow_email_only

string

Set true to accept rows with a blank (or absent) user_id and an email: each resolves to the account a pending email link or a single live profile email already names, or else creates an account with a pending email link at the provider, so that person's first sign-in there lands in it. Default false.

one of "true" | "false"

file

string (binary)

yes

CSV file, at most 1 MB: a header row naming a `user_id` (the OIDC `sub` claim at the named provider; `user_subject`, `subject` and `sub` are accepted too), `name` (or `display_name`) and `email` column in any order, then one member per row. Header matching is case-insensitive and extra columns are ignored. A member's name and email cells may be left blank; they seed a newly created account's profile. With `allow_email_only`, the user_id column may be blank or missing and rows are matched by email instead.

jsonExample

{
  "provider_id": "acme-sso",
  "allow_email_only": "true",
  "file": "string"
}