Skip to main content

Custom Parameters

Custom parameters can be added to the auth request by adding them to the config.

They are provided by:

customParamsAuthRequest?: {
    [key: string]: string | number | boolean;
};

And you can pass them as an object like this:

export const appConfig: ApplicationConfig = {
  providers: [
    provideAuth({
      authority: '<your authority address here>',
      customParamsAuthRequest: {
        response_mode: 'fragment',
        prompt: 'consent',
      },
    }),
  ],
};

Dynamic custom parameters​

If you want to pass dynamic custom parameters with the request URL to the Security Token Service, you can do this by passing the parameters into the authorize method:

login() {
  this.oidcSecurityService.authorize(null, { customParams: { ui_locales: 'de-CH' }});
}

If you want to pass static parameters to the Security Token Service every time please use the custom parameters in the Configuration instead!

NgModule​

If you want to use custom parameters in the NgModule, you can do this as follows:

AuthModule.forRoot({
  config: {
    authority: '<your authority address here>',
    customParamsAuthRequest: {
      response_mode: 'fragment',
      prompt: 'consent',
    },
  },
}),