AddDirectoryUserRequest

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

AddDirectoryUserRequest

FieldTypeRequiredDescription
user_idstring (uuid)no

The member's account id (`users.id`). Mutually exclusive with provider_id/subject.

provider_idstringno

Sign-in provider UUID id or slug.

at least 1 character

subjectstringno

OIDC `sub` claim the member will present at that provider.

1–255 characters

display_namestringno

Starting profile for a newly created account; ignored for an existing one.

1–300 characters

emailstringno

1–300 characters

jsonExample
{
  "user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "provider_id": "acme-sso",
  "subject": "auth0|507f1f77bcf86cd799439011",
  "display_name": "string",
  "email": "string"
}