Skip to content
Docs
Reference

Interface: InvitationStartResult

Interface: InvitationStartResult in @ticketlayer/backstage.

@ticketlayer/backstage


@ticketlayer/backstage / InvitationStartResult

Defined in: auth/index.ts:186

Properties#

alternatives#

alternatives: "email_code"[];

Defined in: auth/index.ts:195


authSession#

authSession: string;

Defined in: auth/index.ts:188

The handle the next step takes.


email#

email: string;

Defined in: auth/index.ts:197

The address the invitation was sent to, which is who signs in.


expiresIn#

expiresIn: number;

Defined in: auth/index.ts:200


method#

method: "password" | "set_password";

Defined in: auth/index.ts:194

password: the invited address has an account; sign in with the handle (password, or sendEmailCode then emailCode, then mfa if asked). set_password: it has none; invitation.accept with a password and a name.


organisation#

organisation: {
  name: string;
  slug: string;
};

Defined in: auth/index.ts:199

The organisation it is for. The code the last step answers is pinned to it.

name#

name: string;

slug#

slug: string;