mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
a7cdcbf7b9
* [ADF-3551] Updated docs plus minor ToC tool fix * [ADF-3551] Updated docs and JSDocs * [ADF-3551] Updated docs and JSDocs
105 lines
4.4 KiB
Markdown
105 lines
4.4 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-09-13
|
|
---
|
|
|
|
# Authentication Service
|
|
|
|
Provides authentication to ACS and APS.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<UserRepresentation>`<br/>
|
|
Gets information about the user currently logged into APS.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<UserRepresentation>` - User information
|
|
- **getBpmUsername**(): `string`<br/>
|
|
Gets the BPM username
|
|
- **Returns** `string` - The BPM username
|
|
- **getEcmUsername**(): `string`<br/>
|
|
Gets the ECM username.
|
|
- **Returns** `string` - The ECM username
|
|
- **getRedirect**(provider: `string`): `string`<br/>
|
|
Gets the URL to redirect to after login.
|
|
- _provider:_ `string` - Service provider. Can be "ECM", "BPM" or "ALL".
|
|
- **Returns** `string` - The redirect URL
|
|
- **getTicketBpm**(): `string|null`<br/>
|
|
Gets the BPM ticket stored in the Storage.
|
|
- **Returns** `string|null` - The ticket or `null` if none was found
|
|
- **getTicketEcm**(): `string|null`<br/>
|
|
Gets the ECM ticket stored in the Storage.
|
|
- **Returns** `string|null` - The ticket or `null` if none was found
|
|
- **getTicketEcmBase64**(): `string|null`<br/>
|
|
Gets the BPM ticket from the Storage in Base 64 format.
|
|
- **Returns** `string|null` - The ticket or `null` if none was found
|
|
- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Prints an error message in the console browser
|
|
- _error:_ `any` - Error message
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
|
|
- **isALLProvider**(): `boolean`<br/>
|
|
Does the provider support both ECM and BPM?
|
|
- **Returns** `boolean` - True if both are supported, false otherwise
|
|
- **isBPMProvider**(): `boolean`<br/>
|
|
Does the provider support BPM?
|
|
- **Returns** `boolean` - True if supported, false otherwise
|
|
- **isBpmLoggedIn**(): `boolean`<br/>
|
|
Checks if the user is logged in on a BPM provider.
|
|
- **Returns** `boolean` - True if logged in, false otherwise
|
|
- **isECMProvider**(): `boolean`<br/>
|
|
Does the provider support ECM?
|
|
- **Returns** `boolean` - True if supported, false otherwise
|
|
- **isEcmLoggedIn**(): `boolean`<br/>
|
|
Checks if the user is logged in on an ECM provider.
|
|
- **Returns** `boolean` - True if logged in, false otherwise
|
|
- **isLoggedIn**(): `boolean`<br/>
|
|
Checks if the user logged in.
|
|
- **Returns** `boolean` - True if logged in, false otherwise
|
|
- **isOauth**(): `boolean`<br/>
|
|
Does the provider support OAuth?
|
|
- **Returns** `boolean` - True if supported, false otherwise
|
|
- **isRememberMeSet**(): `boolean`<br/>
|
|
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`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
|
|
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`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
|
|
- **logout**(): `any`<br/>
|
|
Logs the user out.
|
|
- **Returns** `any` - Response event called when logout is complete
|
|
- **setRedirect**(url: [`RedirectionModel`](../../lib/core/models/redirection.model.ts))<br/>
|
|
Sets the URL to redirect to after login.
|
|
- _url:_ [`RedirectionModel`](../../lib/core/models/redirection.model.ts) - URL to redirect to
|
|
- **ssoImplicitLogin**()<br/>
|
|
Logs the user in with SSO
|
|
|
|
## Details
|
|
|
|
### Usage example
|
|
|
|
```ts
|
|
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](login.component.md)
|