Class SignedHttpRequest

Hierarchy

SignedHttpRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new SignedHttpRequest(shrParameters: Pick<BaseAuthRequest, "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce">, shrOptions?: SignedHttpRequestOptions): SignedHttpRequest

- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:18
Parameters
- shrParameters: Pick<BaseAuthRequest, "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce">
- Optional shrOptions: SignedHttpRequestOptions
Returns SignedHttpRequest

Methods

generatePublicKeyThumbprint

generatePublicKeyThumbprint(): Promise<string>

- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:32
Generates and caches a keypair for the given request options.

Returns Promise<string>

Public key digest, which should be sent to the token issuer.

removeKeys

removeKeys(publicKeyThumbprint: string): Promise<boolean>

- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:59
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

signRequest

signRequest(payload: string, publicKeyThumbprint: string, claims?: object): Promise<string>

- Defined in msal-browser/src/crypto/SignedHttpRequest.ts:45
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

Generated using TypeDoc