AuthenticationConstants Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Values and Constants used for Authentication and Authrization by the Bot Framework Protocol.
public static class AuthenticationConstantstype AuthenticationConstants = classPublic Class AuthenticationConstants- Inheritance
-
AuthenticationConstants
Fields
| AllowedSigningAlgorithms |
Allowed token signing algorithms. Tokens come from channels to the bot. The code that uses this also supports tokens coming from the emulator. |
| AnonymousAuthType |
Indicates that AuthenticationType is anonymous (no app Id and password were provided). |
| AnonymousSkillAppId |
AppId used for creating skill claims when there is no appId and password configured. |
| AppIdClaim |
App ID claim name. As used in Microsoft AAD 1.0 tokens. |
| AudienceClaim |
Audience Claim. From RFC 7519. https://tools.ietf.org/html/rfc7519#section-4.1.3 The "aud" (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the "aud" claim when this claim is present, then the JWT MUST be rejected. In the general case, the "aud" value is an array of case- sensitive strings, each containing a StringOrURI value. In the special case when the JWT has one audience, the "aud" value MAY be a single case-sensitive string containing a StringOrURI value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL. |
| AuthorizedParty |
"azp" Claim. Authorized party - the party to which the ID Token was issued. This claim follows the general format set forth in the OpenID Spec. http://openid.net/specs/openid-connect-core-1_0.html#IDToken. |
| BotOpenIdMetadataKey |
Application Setting Key for the OpenIdMetadataUrl value. |
| DefaultChannelAuthTenant |
The default tenant to acquire bot to channel token from. |
| EmulateOAuthCardsKey |
Application Settings Key for whether to emulate OAuthCards when using the emulator. |
| KeyIdHeader |
From RFC 7515 https://tools.ietf.org/html/rfc7515#section-4.1.4 The "kid" (key ID) Header Parameter is a hint indicating which key was used to secure the JWS. This parameter allows originators to explicitly signal a change of key to recipients. The structure of the "kid" value is unspecified. Its value MUST be a case-sensitive string. Use of this Header Parameter is OPTIONAL. When used with a JWK, the "kid" value is used to match a JWK "kid" parameter value. |
| OAuthUrl |
OAuth Url used to get a token from OAuthApiClient. |
| OAuthUrlKey |
Application Setting Key for the OAuthUrl value. |
| ServiceUrlClaim |
Service URL claim name. As used in Microsoft Bot Framework v3.1 auth. |
| ToBotFromChannelOpenIdMetadataUrl |
TO BOT FROM CHANNEL: OpenID metadata document for tokens coming from MSA. |
| ToBotFromChannelTokenIssuer |
TO BOT FROM CHANNEL: Token issuer. |
| ToBotFromEmulatorOpenIdMetadataUrl |
TO BOT FROM EMULATOR: OpenID metadata document for tokens coming from MSA. |
| ToBotFromEnterpriseChannelOpenIdMetadataUrlFormat |
TO BOT FROM ENTERPRISE CHANNEL: OpenID metadata document for tokens coming from MSA. |
| ToChannelFromBotLoginUrl |
TO CHANNEL FROM BOT: Login URL. DEPRECATED. For binary compat only. |
| ToChannelFromBotLoginUrlTemplate |
TO CHANNEL FROM BOT: Login URL template string. Bot developer may specify which tenant to obtain an access token from. By default, the channels only accept tokens from "botframework.com". For more details see https://aka.ms/bots/tenant-restriction. |
| ToChannelFromBotOAuthScope |
TO CHANNEL FROM BOT: OAuth scope to request. |
| ValidGovernmentTokenIssuerUrlTemplateV1 |
The Government V1 Azure AD token issuer URL template that will contain the tenant id where the token was issued from. |
| ValidGovernmentTokenIssuerUrlTemplateV2 |
The Government V2 Azure AD token issuer URL template that will contain the tenant id where the token was issued from. |
| ValidTokenIssuerUrlTemplateV1 |
The V1 Azure AD token issuer URL template that will contain the tenant id where the token was issued from. |
| ValidTokenIssuerUrlTemplateV2 |
The V2 Azure AD token issuer URL template that will contain the tenant id where the token was issued from. |
| VersionClaim |
Token version claim name. As used in Microsoft AAD tokens. |