Options
All
  • Public
  • Public/Protected
  • All
Menu

ACCESS_TOKEN Credential Type

Key:Value Schema:

Key Example: uid.utid-login.microsoftonline.com-accesstoken-clientId-contoso.com-user.read

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. cachedAt: Absolute device time when entry was created in the cache. expiresOn: Token expiry time, calculated based on current UTC time in seconds. Represented as a string. extendedExpiresOn: Additional extended expiry time until when token is valid in case of server-side outage. Represented as string in UTC seconds. keyId: used for POP and SSH tokenTypes tokenType: Type of the token issued. Usually "Bearer" }

Hierarchy

Index

Constructors

constructor

Properties

cachedAt

cachedAt: string

clientId

clientId: string

credentialType

credentialType: CredentialType

environment

environment: string

expiresOn

expiresOn: string

Optional extendedExpiresOn

extendedExpiresOn: string

Optional familyId

familyId: string

homeAccountId

homeAccountId: string

Optional keyId

keyId: string

Optional oboAssertion

oboAssertion: string

realm

realm: string

Optional refreshOn

refreshOn: string

Optional requestedClaims

requestedClaims: string

Optional requestedClaimsHash

requestedClaimsHash: string

secret

secret: string

target

target: string

Optional tokenType

Methods

generateAccountId

  • generateAccountId(): string

generateCredentialId

  • generateCredentialId(): string

generateCredentialKey

  • generateCredentialKey(): string

generateTarget

  • generateTarget(): string

generateType

  • generateType(): number

Static createAccessTokenEntity

  • createAccessTokenEntity(homeAccountId: string, environment: string, accessToken: string, clientId: string, tenantId: string, scopes: string, expiresOn: number, extExpiresOn: number, cryptoUtils: ICrypto, refreshOn?: number, tokenType?: AuthenticationScheme, oboAssertion?: string, keyId?: string, requestedClaims?: string, requestedClaimsHash?: string): AccessTokenEntity
  • Create AccessTokenEntity

    Parameters

    • homeAccountId: string
    • environment: string
    • accessToken: string
    • clientId: string
    • tenantId: string
    • scopes: string
    • expiresOn: number
    • extExpiresOn: number
    • cryptoUtils: ICrypto
    • Optional refreshOn: number
    • Optional tokenType: AuthenticationScheme
    • Optional oboAssertion: string
    • Optional keyId: string
    • Optional requestedClaims: string
    • Optional requestedClaimsHash: string

    Returns AccessTokenEntity

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

Static isAccessTokenEntity

  • isAccessTokenEntity(entity: object): boolean

Generated using TypeDoc