Skip to content
Docs
Reference

Interface: InvitationStartInput

Interface: InvitationStartInput in @ticketlayer/backstage.

@ticketlayer/backstage


@ticketlayer/backstage / InvitationStartInput

Defined in: auth/index.ts:181

The client half every start step takes: who is asking, their PKCE challenge, and where the code goes.

Extends#

Properties#

clientId?#

optional clientId: string;

Defined in: auth/index.ts:145

Defaults to AuthConfig.clientId. A first-party client only.

Inherited from#

ClientStepInput.clientId


codeChallenge#

codeChallenge: string;

Defined in: auth/index.ts:147

The S256 challenge from pkce().

Inherited from#

ClientStepInput.codeChallenge


dpop?#

optional dpop: Pick<DpopKey, "thumbprint">;

Defined in: auth/index.ts:149

Bind the code (and the tokens) to this key, as for start.

Inherited from#

ClientStepInput.dpop


invitation#

invitation: string;

Defined in: auth/index.ts:183

The invitation code: ?code= in the invitation email's link.


redirectUri?#

optional redirectUri: string;

Defined in: auth/index.ts:151

A redirect URI registered for the client. Defaults to the client's first.

Inherited from#

ClientStepInput.redirectUri


scope?#

optional scope: string;

Defined in: auth/index.ts:153

Space-separated scopes. Defaults to openid profile email organisations.

Inherited from#

ClientStepInput.scope