inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b3c0c8380b0978ef48eccfe155e15c0f94bad8fc
alfresco-ng2-components/docs/core/services/auth-guard-sso-role.service.md
Andy Stark 7fe066b068 [ADF-4249] Updates for doc review (#4454) 
* [ADF-4249] Updates for doc review

* [ADF-4249] Clarified text slightly
2019-03-19 15:35:59 +00:00

1.7 KiB
Raw Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Auth Guard SSO Role service v3.1.0 Active 2019-03-19

Auth Guard SSO role service

Checks the user roles of a user.

Details

The Auth Guard SSO role service implements an Angular route guard to check the user has the right role permission. This is typically used with the canActivate guard check in the route definition. The roles that user needs to have in order to access the route has to be specified in the roles array as in the example below:

const appRoutes: Routes = [
    ...
    {
        path: 'examplepath',
        component: ExampleComponent,
        canActivate: [ AuthGuardSsoRoleService ],
        data: { roles: ['USER_ROLE1', 'USER_ROLE2']}
    },
    ...
]

If the user now clicks on a link or button that follows this route, they will be not able to access this content if they do not have the roles.

Redirect over forbidden

If the you want to redirect the user to a page after a forbidden access, you can use the redirectUrl as in the example below:

const appRoutes: Routes = [
    ...
    {
        path: 'examplepath',
        component: ExampleComponent,
        canActivate: [ AuthGuardSsoRoleService ],
        data: { roles: ['ACTIVITI_USER'], redirectUrl: '/error/403'}
    },
    ...
]

Note: you can use this Guard in and with the other ADF auth guards.

See also