method

RiduClient.login

RiduClient.login<Slug extends AuthCollectionSlug<Config>>(
	collection: Slug,
	credentials: LoginCredentials,
	options?: RequestOptions,
): Promise<AuthSession<OutputFor<Config, Slug>>>

Authenticate against an auth-enabled collection.

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

@param collection: The collection value.
@param credentials: The credentials value.
@param options: The options value.
@returns: The declared result.

Related types

AuthCollectionSlug
Collection slugs with the generated auth capability.
LoginCredentials
Email and password credentials.
RequestOptions
Options shared by every request.
AuthSession
An authenticated user session.
OutputFor
Resolve a collection document output type.