Registry /
auth-security / angular-auth-oidc-client
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
AuthModule
✓ import { AuthModule } from 'angular-auth-oidc-client'
✗ import AuthModule from 'angular-auth-oidc-client'
Named export. ForRoot configuration required.
OidcConfiguration
✓ import { OidcConfiguration } from 'angular-auth-oidc-client'
✗ import { OidcConfig } from 'angular-auth-oidc-client'
Type for configuration object.
AuthService
✓ import { AuthService } from 'angular-auth-oidc-client'
✗ import { AuthService } from 'angular-auth-oidc-client/src/auth.service'
Main service for authentication operations.
LogLevel
✓ import { LogLevel } from 'angular-auth-oidc-client'
Enum for log level configuration.
OidcSecurityService
✓ import { OidcSecurityService } from 'angular-auth-oidc-client'
✗ import { OidcSecurityService } from 'angular-auth-oidc-client/src/oidc-security.service'
Deprecated alias for AuthService since v20.
AuthResult
✓ import { AuthResult } from 'angular-auth-oidc-client'
✗ import { AuthResult } from 'angular-auth-oidc-client/auth-helper'
Type for authentication result. Exported since v20.0.1.
Shows basic configuration of AuthModule with forRoot and a simple login button in a component.
import { NgModule } from '@angular/core';
import { AuthModule, LogLevel } from 'angular-auth-oidc-client';
@NgModule({
imports: [
AuthModule.forRoot({
config: {
authority: 'https://your-identity-server.com',
redirectUrl: window.location.origin + '/callback',
clientId: 'your-client-id',
scope: 'openid profile email offline_access',
responseType: 'code',
silentRenew: true,
useRefreshToken: true,
logLevel: LogLevel.Debug,
secureRoutes: ['/api', '/protected'],
},
}),
],
providers: [],
})
export class AppModule {};
// In component:
import { Component } from '@angular/core';
import { AuthService } from 'angular-auth-oidc-client';
@Component({ selector: 'app-root', template: '<button (click)="login()">Login</button>' })
export class AppComponent {
constructor(private authService: AuthService) {}
login(): void {
this.authService.authorize();
}
}
Errors
Common errors & fixes
TypeError: Cannot read properties of undefined (reading 'authorize')
AuthService not properly injected, possibly due to missing AuthModule.forRoot.
fixEnsure AuthModule.forRoot() is imported in your AppModule.
Error: Configuration 'your-config-id' not found.
Providing a configId in authorize() that does not match any configuration.
fixCheck the configId parameter matches the one defined in AuthModule.forRoot().
Error: The issuer is not valid (strict issuer validation).
OIDC well-known endpoint returns an issuer mismatch.
fixSet strictWellKnownIssuerValidation: false in config or correct the authority URL.
ERROR Error: Uncaught (in promise): TypeError: Cannot read properties of undefined (reading 'access_token')
AuthResult not handled correctly; access_token may be undefined if authentication failed.
fixCheck the isAuthenticated flag in AuthResult before accessing token properties.
Audit
Dependencies
@angular/corerequiredPeer dependency for Angular integration
@angular/commonrequiredPeer dependency for Angular common utilities
@angular/routerrequiredPeer dependency for Angular routing and guards
rxjsrequiredPeer dependency for reactive programming