Skip to content

Latest commit

 

History

History
73 lines (64 loc) · 3 KB

jwt-helper.service.md

File metadata and controls

73 lines (64 loc) · 3 KB
Raw
Title Added Status Last reviewed
JWT helper service
v3.0.0
Active
2019-01-09

JWT helper service

Decodes a JSON Web Token (JWT) to a JavaScript object.

Class members

Methods

  • decodeToken(token: any): any
    Decodes a JSON web token into a JS object.
    • token: any - Token in encoded form
    • Returns any - Decoded token data object
  • getAccessToken(): string
    Gets access token
    • Returns string - access token
  • getClientRoles(clientName: string): string[]
    Gets Client roles.
    • clientName: string -
    • Returns string[] - Array of client roles
  • getIdToken(): string
    Gets id token
    • Returns string - id token
  • getRealmRoles(): string[]
    Gets realm roles.
    • Returns string[] - Array of realm roles
  • getValueFromLocalAccessToken(key: string)
    Gets a named value from the user access token.
    • key: string - Key name of the field to retrieve
  • getValueFromLocalIdToken(key: string)
    Gets a named value from the user id token.
    • key: string - Key name of the field to retrieve
  • getValueFromLocalToken(key: string)
    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)
    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
    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
    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
    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
    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 for full details of the standard and its uses.

See also