Skip to content
Docs
Reference

Interface: StartInput

Interface: StartInput in @ticketlayer/backstage.

@ticketlayer/backstage


@ticketlayer/backstage / StartInput

Defined in: auth/index.ts:107

Properties#

clientId?#

optional clientId: string;

Defined in: auth/index.ts:110

Defaults to AuthConfig.clientId. A first-party client only: any other is refused (403 FIRST_PARTY_CLIENT_REQUIRED).


codeChallenge#

codeChallenge: string;

Defined in: auth/index.ts:112

The S256 challenge from pkce().


dpop?#

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

Defined in: auth/index.ts:118

The DPoP key the tokens will be bound to. Its thumbprint goes as dpop_jkt, which binds the code to the key (so it can only be redeemed with a proof from it) and is what the per-installation rate limit counts.


email#

email: string;

Defined in: auth/index.ts:108


organisation?#

optional organisation: string;

Defined in: auth/index.ts:124

An organisation slug to pin the first token to. Without one: the person's only organisation, or none.


redirectUri?#

optional redirectUri: string;

Defined in: auth/index.ts:120

A redirect URI registered for the client. Defaults to the client's first. Echoed back with the code.


scope?#

optional scope: string;

Defined in: auth/index.ts:122

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