Options
All
  • Public
  • Public/Protected
  • All
Menu

Base type for credentials to be stored in the cache: eg: ACCESS_TOKEN, ID_TOKEN etc

Key:Value Schema:

Key: <home_account_id*>----<realm*>-<target*>-<requestedClaims*>-<scheme*>

Value Schema: { homeAccountId: home account identifier for the auth scheme, environment: entity that issued the token, represented as a full host credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other clientId: client ID of the application secret: Actual credential as a string familyId: Family ID identifier, usually only used for refresh tokens realm: Full tenant or organizational identifier that the account belongs to target: Permissions that are included in the token, or for refresh tokens, the resource identifier. oboAssertion: access token passed in as part of OBO request tokenType: Matches the authentication scheme for which the token was issued (i.e. Bearer or pop) requestedClaimsHash: Matches the SHA 256 hash of the claims object included in the token request }

Hierarchy

Index

Constructors

constructor

Properties

clientId

clientId: string

credentialType

credentialType: CredentialType

environment

environment: string

Optional familyId

familyId: string

homeAccountId

homeAccountId: string

Optional keyId

keyId: string

Optional oboAssertion

oboAssertion: string

Optional realm

realm: string

Optional requestedClaimsHash

requestedClaimsHash: string

secret

secret: string

Optional target

target: string

Optional tokenType

Methods

generateAccountId

  • generateAccountId(): string

generateCredentialId

  • generateCredentialId(): string

generateCredentialKey

  • generateCredentialKey(): string

generateTarget

  • generateTarget(): string

generateType

  • generateType(): number

Static generateCredentialCacheKey

  • generateCredentialCacheKey(homeAccountId: string, environment: string, credentialType: CredentialType, clientId: string, realm?: string, target?: string, familyId?: string, tokenType?: AuthenticationScheme, requestedClaimsHash?: string): string

Static getCredentialType

  • getCredentialType(key: string): string

Generated using TypeDoc