Class SignedHttpRequest

Hierarchy

SignedHttpRequest

Index

Constructors

Methods

generatePublicKeyThumbprint removeKeys signRequest

Constructors

constructor

new SignedHttpRequest(shrParameters, shrOptions?): SignedHttpRequest
Parameters
- shrParameters: SignedHttpRequestParameters
- Optional shrOptions: SignedHttpRequestOptions
Returns SignedHttpRequest
- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:25

Methods

generatePublicKeyThumbprint

generatePublicKeyThumbprint(): Promise<string>
Generates and caches a keypair for the given request options.

Returns Promise<string>
Public key digest, which should be sent to the token issuer.
- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:40

removeKeys

removeKeys(publicKeyThumbprint): Promise<boolean>
Removes cached keys from browser for given public key thumbprint
Parameters
- publicKeyThumbprint: string
  
  Public key digest (from generatePublicKeyThumbprint API)
Returns Promise<boolean>
If keys are properly deleted
- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:73

signRequest

signRequest(payload, publicKeyThumbprint, claims?): Promise<string>
Generates a signed http request for the given payload with the given key.
Parameters
- payload: string
  
  Payload to sign (e.g. access token)
- publicKeyThumbprint: string
  
  Public key digest (from generatePublicKeyThumbprint API)
- Optional claims: object
  
  Additional claims to include/override in the signed JWT
Returns Promise<string>
Pop token signed with the corresponding private key
- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:55

Generated using TypeDoc