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. 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 userAssertionHash: Matches the SHA 256 hash of the obo_assertion for the OBO flow }

Hierarchy

Constructors

Properties

clientId: string
credentialType: CredentialType
environment: string
familyId?: string
homeAccountId: string
keyId?: string
realm?: string
requestedClaimsHash?: string
secret: string
target?: string
userAssertionHash?: string

Methods

  • generates credential key <home_account_id*>-<environment>---<realm*>-<target*>-<scheme*>

    Parameters

    • homeAccountId: string
    • environment: string
    • credentialType: CredentialType
    • clientId: string
    • Optional realm: string
    • Optional target: string
    • Optional familyId: string
    • Optional tokenType: AuthenticationScheme
    • Optional requestedClaimsHash: string

    Returns string

Generated using TypeDoc