method

RiduAuth.createUser

Create a user in an auth-enabled collection, including sign-up.

Arguments

Argument	Type	Description
`input`	`[Slug] extends [never] ? never : { data: DraftCreateFor<Config, Slug>; password: string; } & AuthCollectionInput<DefaultAuth, Slug>`	The new user document, password, and optional collection.
`options`	`(MutationLocaleOptions<LocaleFor<Config>> & { draft?: boolean; } & { draft?: true; }) \| undefined`	Locale and request options.

Returns

The declared result.

Promise<OutputFor<Config, Slug>>

Full signature (2 overloads)

RiduAuth.createUser<
	Slug extends Extract<
			AuthCollectionSlug<Config>,
			DraftCollectionSlug<Config>,
		> = Extract<SessionCollection<Config, DefaultAuth>, DraftCollectionSlug<Config>>,
>(
	input: [Slug] extends [never] ? never : {
		data: DraftCreateFor<
		Config,
		Slug,
	>
		password: string
	} & AuthCollectionInput<DefaultAuth, Slug>,
	options?: CreateOptions<LocaleFor<Config>, true, true> & { draft?: true; },
): Promise<OutputFor<Config, Slug>>
RiduAuth.createUser<
	Slug extends AuthCollectionSlug<Config> = SessionCollection<Config, DefaultAuth>
>(
	input: {
		data: CreateFor<
		Config,
		Slug,
	>
		password: string
	} & AuthCollectionInput<DefaultAuth, Slug>,
	options?: CreateOptions<
		LocaleFor<Config>,
		CollectionVersionsFor<Config, Slug>,
		CollectionDraftsFor<Config, Slug>,
	>,
): Promise<OutputFor<Config, Slug>>

Source packages/sdk/src/types.ts:1598

Related types

AuthCollectionSlug
Collection slugs with the generated auth capability.
DraftCollectionSlug
Collection slugs with the generated drafts capability.
SessionCollection
Auth collections a client's sessions can belong to: its default, or every auth collection.
DraftCreateFor
Generated input for creating an incomplete draft-capable document.
AuthCollectionInput
Selects the auth collection for one call. It is optional only when the client was created with auth.collection, which becomes Default; otherwise every call names its collection.
CreateOptions
Create options, including explicit draft or publish intent for versioned collections.
OutputFor
Resolve a collection document output type.
CreateFor
Resolve a collection create input type.
MutationLocaleOptions
Locale and transport options shared by mutations without an optimistic-concurrency contract.