Interface: AuthConfig

@ticketlayer/backstage

@ticketlayer/backstage / AuthConfig

Defined in: auth/index.ts:77

Properties#

clientId?#

optional clientId: string;

Defined in: auth/index.ts:85

The client id used when a call names none (backstage-boxoffice-desktop, backstage-shell, ...).

credentials?#

optional credentials: RequestCredentials;

Defined in: auth/index.ts:97

fetch credentials for the four sign-in steps. The shell's browser sign-in page sets 'include', so the steps also leave the issuer's own login session (one sign-in covers a later third-party consent). A packaged app leaves it unset, and so leaves no web session behind on a shared till.

debug?#

optional debug: boolean | DebugConfig;

Defined in: auth/index.ts:99

As BackstageClientConfig.debug. Secrets are never printed either way.

headers?#

optional headers: Record<string, string>;

Defined in: auth/index.ts:101

Extra headers for the sign-in steps.

issuerUrl#

issuerUrl: string;

Defined in: auth/index.ts:83

The identity issuer's base URL: https://auth.<domain> (https://auth.staging.t9r.dev on staging). Separate from the API's baseUrl, because the issuer is its own host.

revocationEndpoint?#

optional revocationEndpoint: string;

Defined in: auth/index.ts:89

The RFC 7009 revocation endpoint. Defaults to <issuerUrl>/oauth/revoke, as the issuer's discovery document says.

tokenEndpoint?#

optional tokenEndpoint: string;

Defined in: auth/index.ts:87

The token endpoint. Defaults to <issuerUrl>/oauth/token, as the issuer's discovery document says.