method

RiduAuth.bootstrap

Check whether an auth collection still permits its first bootstrap user.

Arguments

ArgumentTypeDescription
inputAuthCollectionInput<DefaultAuth, Slug>The auth collection to check.
optionsRequestOptions | undefinedRequest options such as an AbortSignal.

Returns

The declared result.

Promise<AuthBootstrapEnvelope>

Full signature

RiduAuth.bootstrap< Slug extends AuthCollectionSlug<Config> = SessionCollection<Config, DefaultAuth> >( input: AuthCollectionInput<DefaultAuth, Slug>, options?: RequestOptions, ): Promise<AuthBootstrapEnvelope>

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

Related types

  • AuthCollectionSlug

    Collection slugs with the generated auth capability.

  • SessionCollection

    Auth collections a client's sessions can belong to: its default, or every auth collection.

  • 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.

  • RequestOptions

    Options shared by every request.

  • AuthBootstrapEnvelope

    Whether the configured admin collection still allows one-time first-user setup.