mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
74 lines
3.0 KiB
Markdown
74 lines
3.0 KiB
Markdown
---
|
|
Title: JWT helper service
|
|
Added: v3.0.0
|
|
Status: Active
|
|
Last reviewed: 2019-01-09
|
|
---
|
|
|
|
# [JWT helper service](lib/core/src/lib/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts")
|
|
|
|
Decodes a JSON Web Token (JWT) to a JavaScript object.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **decodeToken**(token: `any`): `any`<br/>
|
|
Decodes a JSON web token into a JS object.
|
|
- _token:_ `any` - Token in encoded form
|
|
- **Returns** `any` - Decoded token data object
|
|
- **getAccessToken**(): `string`<br/>
|
|
Gets access token
|
|
- **Returns** `string` - access token
|
|
- **getClientRoles**(clientName: `string`): `string[]`<br/>
|
|
Gets Client roles.
|
|
- _clientName:_ `string` -
|
|
- **Returns** `string[]` - Array of client roles
|
|
- **getIdToken**(): `string`<br/>
|
|
Gets id token
|
|
- **Returns** `string` - id token
|
|
- **getRealmRoles**(): `string[]`<br/>
|
|
Gets realm roles.
|
|
- **Returns** `string[]` - Array of realm roles
|
|
- **getValueFromLocalAccessToken**(key: `string`)<br/>
|
|
Gets a named value from the user access token.
|
|
- _key:_ `string` - Key name of the field to retrieve
|
|
- **getValueFromLocalIdToken**(key: `string`)<br/>
|
|
Gets a named value from the user id token.
|
|
- _key:_ `string` - Key name of the field to retrieve
|
|
- **getValueFromLocalToken**(key: `string`)<br/>
|
|
Gets a named value from the user access or id token.
|
|
- _key:_ `string` - Key name of the field to retrieve
|
|
- **getValueFromToken**(token: `string`, key: `string`)<br/>
|
|
Gets a named value from the user access token.
|
|
- _token:_ `string` -
|
|
- _key:_ `string` - Key name of the field to retrieve
|
|
- **hasClientRole**(clientName: `string`, role: `string`): `boolean`<br/>
|
|
Checks for client role.
|
|
- _clientName:_ `string` - Targeted client name
|
|
- _role:_ `string` - Role name to check
|
|
- **Returns** `boolean` - True if it contains given role, false otherwise
|
|
- **hasRealmRole**(role: `string`): `boolean`<br/>
|
|
Checks for single realm role.
|
|
- _role:_ `string` - Role name to check
|
|
- **Returns** `boolean` - True if it contains given role, false otherwise
|
|
- **hasRealmRoles**(rolesToCheck: `string[]`): `boolean`<br/>
|
|
Checks for realm roles.
|
|
- _rolesToCheck:_ `string[]` - List of role names to check
|
|
- **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise
|
|
- **hasRealmRolesForClientRole**(clientName: `string`, rolesToCheck: `string[]`): `boolean`<br/>
|
|
Checks for client roles.
|
|
- _clientName:_ `string` - Targeted client name
|
|
- _rolesToCheck:_ `string[]` - List of role names to check
|
|
- **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise
|
|
|
|
## Details
|
|
|
|
JWT is a standard for sending data securely that ADF uses during the
|
|
OAuth2 authentication procedure. See the [JWT website](https://jwt.io/)
|
|
for full details of the standard and its uses.
|
|
|
|
## See also
|
|
|
|
- [Identity user service](identity-user.service.md)
|