\r\n\r\nSecure your Angular app using the latest standards for OpenID Connect & OAuth2. Provides support for token refresh, all modern OIDC Identity Providers and more.\r\n\r\n## Acknowledgements\r\n\r\nThis library is certified by OpenID Foundation. (RP Implicit and Config RP)\r\n\r\n
\r\n \r\n
\r\n\r\n## Features\r\n\r\n- [Code samples](https://angular-auth-oidc-client.com/docs/samples/) for most of the common use cases\r\n- Supports schematics via `ng add` support\r\n- Supports all modern OIDC identity providers\r\n- Supports OpenID Connect Code Flow with PKCE\r\n- Supports Code Flow PKCE with Refresh tokens\r\n- [Supports OpenID Connect Implicit Flow](http://openid.net/specs/openid-connect-implicit-1_0.html)\r\n- [Supports OpenID Connect Session Management 1.0](http://openid.net/specs/openid-connect-session-1_0.html)\r\n- [Supports RFC7009 - OAuth 2.0 Token Revocation](https://tools.ietf.org/html/rfc7009)\r\n- [Supports RFC7636 - Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636)\r\n- [Supports OAuth 2.0 Pushed authorisation requests (PAR) draft](https://tools.ietf.org/html/draft-ietf-oauth-par-06)\r\n- Semantic releases\r\n- Github actions\r\n- Modern coding guidelines with prettier, husky\r\n- Up to date documentation\r\n- Implements OIDC validation as specified, complete client side validation for REQUIRED features\r\n- Supports authentication using redirect or popup\r\n\r\n## Installation\r\n\r\n### Ng Add\r\n\r\nYou can use the schematics and `ng add` the library.\r\n\r\n```shell\r\nng add angular-auth-oidc-client\r\n```\r\n\r\nAnd answer the questions. A module will be created which encapsulates your configuration.\r\n\r\n\r\n\r\n### Npm / Yarn\r\n\r\nNavigate to the level of your `package.json` and type\r\n\r\n```shell\r\n npm install angular-auth-oidc-client\r\n```\r\n\r\nor with yarn\r\n\r\n```shell\r\n yarn add angular-auth-oidc-client\r\n```\r\n\r\n## Documentation\r\n\r\n[Read the docs here](https://angular-auth-oidc-client.com/)\r\n\r\n## Samples\r\n\r\n[Explore the Samples here](https://angular-auth-oidc-client.com/docs/samples/)\r\n\r\n## Quickstart\r\n\r\nFor the example of the Code Flow. For further examples please check the [Samples](https://angular-auth-oidc-client.com/docs/samples/) Section.\r\n\r\n> If you have done the installation with the schematics, these modules and files should be available already!\r\n\r\n### Configuration\r\n\r\nImport the `AuthModule` in your module.\r\n\r\n```ts\r\nimport { NgModule } from '@angular/core';\r\nimport { AuthModule, LogLevel } from 'angular-auth-oidc-client';\r\n// ...\r\n\r\n@NgModule({\r\n // ...\r\n imports: [\r\n // ...\r\n AuthModule.forRoot({\r\n config: {\r\n authority: '',\r\n redirectUrl: window.location.origin,\r\n postLogoutRedirectUri: window.location.origin,\r\n clientId: '',\r\n scope: 'openid profile email offline_access',\r\n responseType: 'code',\r\n silentRenew: true,\r\n useRefreshToken: true,\r\n logLevel: LogLevel.Debug,\r\n },\r\n }),\r\n ],\r\n // ...\r\n})\r\nexport class AppModule {}\r\n```\r\n\r\nWhen using `silentRenew` together with `useRefreshToken`, requesting the\r\n`offline_access` scope is common and remains the default recommendation.\r\nSome providers support refresh token renewal in the browser without\r\n`offline_access`. In those cases, you can suppress the configuration warning\r\nwith `disableRefreshTokenOfflineAccessScopeWarning: true`.\r\n\r\nAnd call the method `checkAuth()` from your `app.component.ts`. The method `checkAuth()` is needed to process the redirect from your Security Token Service and set the correct states. This method must be used to ensure the correct functioning of the library.\r\n\r\n```ts\r\nimport { Component, OnInit, inject } from '@angular/core';\r\nimport { OidcSecurityService } from 'angular-auth-oidc-client';\r\n\r\n@Component({\r\n /*...*/\r\n})\r\nexport class AppComponent implements OnInit {\r\n private readonly oidcSecurityService = inject(OidcSecurityService);\r\n\r\n ngOnInit() {\r\n this.oidcSecurityService.checkAuth().subscribe((loginResponse: LoginResponse) => {\r\n const { isAuthenticated, userData, accessToken, idToken, configId } = loginResponse;\r\n\r\n /*...*/\r\n });\r\n }\r\n\r\n login() {\r\n this.oidcSecurityService.authorize();\r\n }\r\n\r\n logout() {\r\n this.oidcSecurityService.logoff().subscribe((result) => console.log(result));\r\n }\r\n}\r\n```\r\n\r\n### Using the access token\r\n\r\nYou can get the access token by calling the method `getAccessToken()` on the `OidcSecurityService`\r\n\r\n```ts\r\nconst token = this.oidcSecurityService.getAccessToken().subscribe(...);\r\n```\r\n\r\nAnd then you can use it in the HttpHeaders\r\n\r\n```ts\r\nimport { HttpHeaders } from '@angular/common/http';\r\n\r\nconst token = this.oidcSecurityServices.getAccessToken().subscribe((token) => {\r\n const httpOptions = {\r\n headers: new HttpHeaders({\r\n Authorization: 'Bearer ' + token,\r\n }),\r\n };\r\n});\r\n```\r\n\r\nYou can use the built in interceptor to add the accesstokens to your request\r\n\r\n```ts\r\nAuthModule.forRoot({\r\n config: {\r\n // ...\r\n secureRoutes: ['https://my-secure-url.com/', 'https://my-second-secure-url.com/'],\r\n },\r\n}),\r\n```\r\n\r\n```ts\r\n providers: [\r\n { provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true },\r\n ],\r\n```\r\n\r\n## Versions\r\n\r\nCurrent Version is Version 22.x\r\n\r\n- [Info about Version 20](https://github.com/damienbod/angular-auth-oidc-client/tree/version-21)\r\n- [Info about Version 20](https://github.com/damienbod/angular-auth-oidc-client/tree/version-20)\r\n- [Info about Version 19](https://github.com/damienbod/angular-auth-oidc-client/tree/version-19)\r\n- [Info about Version 18](https://github.com/damienbod/angular-auth-oidc-client/tree/version-18)\r\n- [Info about Version 17](https://github.com/damienbod/angular-auth-oidc-client/tree/version-17)\r\n- [Info about Version 16](https://github.com/damienbod/angular-auth-oidc-client/tree/version-16)\r\n- [Info about Version 15](https://github.com/damienbod/angular-auth-oidc-client/tree/version-15)\r\n- [Info about Version 14](https://github.com/damienbod/angular-auth-oidc-client/tree/version-14)\r\n- [Info about Version 13](https://github.com/damienbod/angular-auth-oidc-client/tree/version-13)\r\n- [Info about Version 12](https://github.com/damienbod/angular-auth-oidc-client/tree/version-12)\r\n- [Info about Version 11](https://github.com/damienbod/angular-auth-oidc-client/tree/version-11)\r\n- [Info about Version 10](https://github.com/damienbod/angular-auth-oidc-client/tree/version-10)\r\n\r\n## License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n\r\n## Authors\r\n\r\n- [@DamienBod](https://www.github.com/damienbod)\r\n- [@FabianGosebrink](https://www.github.com/FabianGosebrink)\r\n","readmeFilename":"README.md","users":{"iamkhova":true,"damienbod":true,"alessandroraffa":true}}
![\"\"](\"https://raw.githubusercontent.com/damienbod/angular-auth-oidc-client/main/.github/angular-auth-logo.png\"){kind=logo}
\r\n![\"\"](\"https://damienbod.files.wordpress.com/2017/06/oid-l-certification-mark-l-rgb-150dpi-90mm.png\")
\r\n