EndorsementsRetriever Class

Definition

Namespace:

Microsoft.Bot.Connector.Authentication

Assembly:

Microsoft.Bot.Connector.dll

Package:

Microsoft.Bot.Connector v4.18.1

The endorsements property within each key contains one or more endorsement strings which you can use to verify that the channel ID specified in the channelId property within the Activity object of the incoming request is authentic. More details at: https://docs.microsoft.com/bot-framework/rest-api/bot-framework-rest-connector-authentication.

public sealed class EndorsementsRetriever : Microsoft.IdentityModel.Protocols.IConfigurationRetriever<System.Collections.Generic.IDictionary<string,System.Collections.Generic.HashSet<string>>>, Microsoft.IdentityModel.Protocols.IDocumentRetriever

type EndorsementsRetriever = class
    interface IDocumentRetriever
    interface IConfigurationRetriever<IDictionary<string, HashSet<string>>>

Public NotInheritable Class EndorsementsRetriever
Implements IConfigurationRetriever(Of IDictionary(Of String, HashSet(Of String))), IDocumentRetriever

Inheritance

Object

EndorsementsRetriever

Implements

IConfigurationRetriever<IDictionary<String,HashSet<String>>> IDocumentRetriever

Constructors

EndorsementsRetriever(HttpClient)

Initializes a new instance of the EndorsementsRetriever class.

Fields

JsonWebKeySetUri

JSON Web Key Set Metadata value From the OpenID Spec at https://openid.net/specs/openid-connect-discovery-1_0.html URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

Methods

GetConfigurationAsync(String, IDocumentRetriever, CancellationToken)	Retrieves a populated configuration given an address and a document retriever.
GetDocumentAsync(String, CancellationToken)	Obtains a document from an address.