mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Manual fixes to core doc file links * [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
committed by
Eugenio Romano
parent
285e56e9fb
commit
5fc05da7aa
44
docs/core/services/auth-guard-bpm.service.md
Normal file
44
docs/core/services/auth-guard-bpm.service.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
Title: Auth Guard Bpm service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
---
|
||||
|
||||
# [Auth Guard Bpm service](../../../lib/core/services/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts")
|
||||
|
||||
Adds authentication with Process Services to a route within the app.
|
||||
|
||||
## Details
|
||||
|
||||
The Auth Guard Bpm service implements an Angular
|
||||
[route guard](https://angular.io/guide/router#milestone-5-route-guards)
|
||||
to check the user is logged into Process Services. This is typically used with the
|
||||
`canActivate` guard check in the route definition:
|
||||
|
||||
```ts
|
||||
const appRoutes: Routes = [
|
||||
...
|
||||
{
|
||||
path: 'examplepath',
|
||||
component: ExampleComponent,
|
||||
canActivate: [ AuthGuardBpm ] // <- Requires authentication for this route.
|
||||
},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
If the user now clicks on a link or button that follows this route, they will be prompted
|
||||
to log in before proceeding.
|
||||
|
||||
This service only accepts authentication with APS but you can use the
|
||||
[Auth Guard Ecm service](auth-guard-ecm.service.md) to authenticate
|
||||
against ACS or the [Auth Guard service](auth-guard.service.md) to authenticate against
|
||||
either ACS or APS. See the
|
||||
[ADF custom page tutorial](https://community.alfresco.com/docs/DOC-6628-adf-105-creating-custom-pages-and-components)
|
||||
for worked examples of all three guards.
|
||||
|
||||
## See also
|
||||
|
||||
- [Auth guard ecm service](auth-guard-ecm.service.md)
|
||||
- [Auth guard service](auth-guard.service.md)
|
Reference in New Issue
Block a user