Share via


SignedHttpRequestDescriptor Class

Definition

Structure that wraps parameters needed for SignedHttpRequest creation.

public class SignedHttpRequestDescriptor
type SignedHttpRequestDescriptor = class
Public Class SignedHttpRequestDescriptor
Inheritance
SignedHttpRequestDescriptor

Constructors

SignedHttpRequestDescriptor(String, HttpRequestData, SigningCredentials)

Initializes a new instance of SignedHttpRequestDescriptor.

SignedHttpRequestDescriptor(String, HttpRequestData, SigningCredentials, SignedHttpRequestCreationParameters)

Initializes a new instance of SignedHttpRequestDescriptor.

Properties

AccessToken

Gets an access token that contains the 'cnf' claim.

AdditionalHeaderClaims

Gets or sets the Dictionary<TKey,TValue> which contains any custom header claims that need to be added to the SignedHttpRequest token header. The 'alg', 'kid', and 'x5t' claims are added by default based on the provided SigningCredentials and SHOULD NOT be included in this dictionary as this will result in an exception being thrown.

AdditionalPayloadClaims

Gets or sets the Dictionary<TKey,TValue> which contains any custom payload claims that need to be added to the SignedHttpRequest token payload. Default SignedHttpRequest payload claims (SignedHttpRequestClaimTypes) will NOT be overwritten by AdditionalPayloadClaims.

CnfClaimValue

Gets or sets a "cnf" claim value as a JSON string.

CustomNonceValue

Gets or sets a custom value that will be set when creating a Nonce claim.

HttpRequestData

A structure that represents an outgoing http request.

SignedHttpRequestCreationParameters

Gets a set of parameters required for creating a SignedHttpRequest.

SigningCredentials

Gets signing credentials that are used to sign a (Signed)HttpRequest.

Applies to