authentication.service.md

Title	Added	Status	Last reviewed
Authentication Service	v2.0.0	Active	2019-03-19

Authentication Service

Provides authentication to ACS and APS.

Class members

Methods

• addTokenToHeader(headersArg?: HttpHeaders): Observable<HttpHeaders>
  Adds the auth token to an HTTP header using the 'bearer' scheme.

  • headersArg: HttpHeaders - (Optional) Header that will receive the token
  • Returns Observable<HttpHeaders> - The new header with the token added

• getBearerExcludedUrls()
  Gets the set of URLs that the token bearer is excluded from.

• getBpmLoggedUser(): Observable<UserRepresentation>
  Gets information about the user currently logged into APS.

  • Returns Observable<UserRepresentation> - User information

• getBpmUsername(): string
  Gets the BPM username

  • Returns string - The BPM username

• getEcmUsername(): string
  Gets the ECM username.

  • Returns string - The ECM username

• getRedirect(): string
  Gets the URL to redirect to after login.

  • Returns string - The redirect URL

• getTicketBpm(): string|null
  Gets the BPM ticket stored in the Storage.

  • Returns string|null - The ticket or null if none was found

• getTicketEcm(): string|null
  Gets the ECM ticket stored in the Storage.

  • Returns string|null - The ticket or null if none was found

• getTicketEcmBase64(): string|null
  Gets the BPM ticket from the Storage in Base 64 format.

  • Returns string|null - The ticket or null if none was found

• getToken(): string
  Gets the auth token.

  • Returns string - Auth token string

• handleError(error: any): Observable<any>
  Prints an error message in the console browser

  • error: any - Error message
  • Returns Observable<any> - Object representing the error message

• isALLProvider(): boolean
  Does the provider support both ECM and BPM?

  • Returns boolean - True if both are supported, false otherwise

• isAuthCodeFlow(): boolean
  

  • Returns boolean -

• isBPMProvider(): boolean
  Does the provider support BPM?

  • Returns boolean - True if supported, false otherwise

• isBpmLoggedIn(): boolean
  Checks if the user is logged in on a BPM provider.

  • Returns boolean - True if logged in, false otherwise

• isECMProvider(): boolean
  Does the provider support ECM?

  • Returns boolean - True if supported, false otherwise

• isEcmLoggedIn(): boolean
  Checks if the user is logged in on an ECM provider.

  • Returns boolean - True if logged in, false otherwise

• isImplicitFlow(): boolean
  

  • Returns boolean -

• isKerberosEnabled(): boolean
  Does kerberos enabled?

  • Returns boolean - True if enabled, false otherwise

• isLoggedIn(): boolean
  Checks if the user logged in.

  • Returns boolean - True if logged in, false otherwise

• isLoggedInWith(provider: string): boolean
  

  • provider: string -
  • Returns boolean -

• isOauth(): boolean
  Does the provider support OAuth?

  • Returns boolean - True if supported, false otherwise

• isPublicUrl(): boolean
  

  • Returns boolean -

• isRememberMeSet(): boolean
  Checks whether the "remember me" cookie was set or not.

  • Returns boolean - True if set, false otherwise

• login(username: string, password: string, rememberMe: boolean = false): Observable<Function>
  Logs the user in.

  • username: string - Username for the login
  • password: string - Password for the login
  • rememberMe: boolean - Stores the user's login details if true
  • Returns Observable<Function> - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket

• logout(): Observable<any>
  Logs the user out.

  • Returns Observable<any> - Response event called when logout is complete

• reset()
  

• saveRememberMeCookie(rememberMe: boolean)
  Saves the "remember me" cookie as either a long-life cookie or a session cookie.

  • rememberMe: boolean - Enables a long-life cookie

• setRedirect(url?: RedirectionModel)
  Sets the URL to redirect to after login.

  • url: RedirectionModel - (Optional) URL to redirect to

• ssoImplicitLogin()
  Logs the user in with SSO

Details

Usage example

import { AuthenticationService } from '@alfresco/adf-core';

@Component({...})
export class AppComponent {
    constructor(authService: AuthenticationService) {
        this.AuthenticationService.login('admin', 'admin').subscribe(
            token => {
                console.log(token);
            },
            error => {
                console.log(error);
            }
        );
    }
}

See also

• Login component