Skip to content

Angular Quickstart

Welcome to the Angular Quickstart guide! In this document, you will learn to build a Angular app, add user login and display user profile information using WSO2 Identity Server.

What You Will Learn

  • Create new Angular app
  • Install angular-oauth2-oidc package
  • Add user login and logout
  • Display user profile information

Prerequisites

Before you start, ensure you have the following:

Configure an Application in WSO2 Identity Server

  • Sign into WSO2 Identity Server console and navigate to Applications > New Application.
  • Select Single Page Application and complete the wizard popup by providing a suitable name and an authorized redirect URL

Example:

  • Name - wso2is-angular
  • Authorized redirect URL - http://localhost:4200

Info

The authorized redirect URL determines where WSO2 Identity Server should send users after they successfully log in. Typically, this will be the web address where your app is hosted. For this guide, we'll usehttp://localhost:4200, as the sample app will be accessible at this URL.

Note

Make a note of the following values from the Protocol and Info tabs of the registered application. You will need them during the Step 4

  • client-id from the Protocol tab.
  • issuer from from the Info tab.

Create an Angular app

Create an Angular app using Angular CLI.

ng new wso2is-angular

Tip

To run the command above, you need to have Angular CLI installed. You can install it using the following command.

npm install -g @angular/cli@17

yarn global add @angular/cli@17

pnpm add -g @angular/cli@17

Install angular-oauth2-oidc

The Angular OAuth2 OIDC SDK is a production-ready OIDC SDK that simplifies integrating WSO2 Identity Server into your Angular applications. To get started, simply add the Angular OAuth2 OIDC SDK to the project. Make sure to stop the dev server started in the previous step. 

npm install angular-oauth2-oidc

yarn add angular-oauth2-oidc

pnpm add angular-oauth2-oidc

Configure AuthConfig in your app

The AuthConfig object holds the configuration necessary for connecting your app to WSO2 Identity Server.

Replace the content of app.config.ts file with the following code.

Important

Make sure to replace the placeholders in the following code with the client-id and issuer values you copied in Step-1 during the application registration in the WSO2 Identity Server console.

  • <your-app-client-id>
  • <your-app-issuer-url>
app.config.ts
import { ApplicationConfig, APP_INITIALIZER } from '@angular/core';
import { provideRouter } from '@angular/router';
import { provideHttpClient } from '@angular/common/http';
import { provideOAuthClient, OAuthService, AuthConfig } from 'angular-oauth2-oidc';
import { routes } from './app.routes';

export const authConfig: AuthConfig = {
  issuer: '<your-app-issuer-url>',
  redirectUri: 'http://localhost:4200',
  clientId: '<your-app-client-id>',
  responseType: 'code',
  scope: 'openid profile email internal_login',
  strictDiscoveryDocumentValidation: false,
};

function initializeOAuth(oauthService: OAuthService): () => Promise<void> {
  return () => {
    oauthService.configure(authConfig);
    return oauthService.loadDiscoveryDocumentAndTryLogin().then(() => { });
  };
}

export const appConfig: ApplicationConfig = {
  providers: [provideRouter(routes),
  provideHttpClient(),
  provideOAuthClient(),
  {
    provide: APP_INITIALIZER,
    useFactory: initializeOAuth,
    deps: [OAuthService],
    multi: true
  }
  ]
};

Important

Make sure to add strictDiscoveryDocumentValidation: false parameter.

Angular uses services to access authentication data, and you can inject the OAuthService into your components to manage user authentication.

The OAuthService provides methods for logging in and out, checking the authentication status, and retrieving access tokens.

Replace the existing content of the app.component.ts file with following content.

app.component.ts
import { Component } from '@angular/core';
import { RouterOutlet } from '@angular/router';
import { OAuthService } from 'angular-oauth2-oidc';
import { CommonModule } from '@angular/common';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [RouterOutlet, CommonModule],
  templateUrl: './app.component.html',
  styleUrl: './app.component.css'
})

export class AppComponent {
  title = 'wso2is-angular';
  isAuthorized = this.oAuthService.hasValidAccessToken();

  constructor(private oAuthService: OAuthService) {

  }

  login() {
    this.oAuthService.initLoginFlow();
  }

  logout() {
    this.oAuthService.revokeTokenAndLogout();
  }
}

Next, replace the existing content of the app.component.html file with following content to add login and logout URLs.

app.component.html
<button *ngIf="!isAuthorized" (click)="login()">Login</button>

<button *ngIf="isAuthorized" (click)="logout()">Logout</button>

Visit your app's homepage at http://localhost:4200.

Important

You need to create a test user in WSO2 Identity Server by following this guide to tryout login and logout features.

Display logged in user details

Modified the code as below to see logged in user details.

Add the username() function to the app.component.ts file to access the username attribute.

app.component.ts
...

  get username() {
    var claims = this.oAuthService.getIdentityClaims();
    if (!claims) return null;
    return claims['username'];
  }

...

Modify the app.component.html file with the following code.

app.component.html
<button *ngIf="!isAuthorized" (click)="login()">Login</button>
<h1 *ngIf="username">Hello {{ username }}!</h1>
<button *ngIf="isAuthorized" (click)="logout()">Logout</button>