Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / auth / AuthMiddlewareProvider

Interface: AuthMiddlewareProvider

Defined in: packages/b2c-tooling-sdk/src/auth/middleware.ts:87

Middleware provider that supplies middleware for auth requests.

Example

typescript
const provider: AuthMiddlewareProvider = {
  name: 'user-agent',
  getMiddleware() {
    return {
      onRequest({ request }) {
        request.headers.set('User-Agent', 'my-app/1.0');
        return request;
      },
    };
  },
};

Properties

name

readonly name: string

Defined in: packages/b2c-tooling-sdk/src/auth/middleware.ts:91

Human-readable name for the provider (used in logging/debugging).

Methods

getMiddleware()

getMiddleware(): AuthMiddleware | undefined

Defined in: packages/b2c-tooling-sdk/src/auth/middleware.ts:98

Returns middleware for auth requests.

Returns

AuthMiddleware | undefined

Middleware to apply, or undefined to skip

Released under the Apache-2.0 License.