AgentClaims Class

Definition

Provides utility methods for working with claims in the context of Agent authentication.

public static class AgentClaims
type AgentClaims = class
Public Module AgentClaims
Inheritance
AgentClaims

Methods

Name Description
AllowAnonymous(ClaimsIdentity)

Determines whether anonymous access is allowed based on the given incoming identity.

CreateIdentity(String, Boolean, String)

Creates an ingress Agent ClaimsIdentity.

DefaultAzureBotServiceScopes(ClaimsIdentity)

Returns the default Azure Bot Service scopes based on the incoming identity. If the incoming identity corresponds to a government Bot Framework claim, it returns the government-specific default scope; otherwise, it returns the standard default scope.

GetAppId(ClaimsIdentity)
Obsolete.

Retrieves the AppId from the given claims identity.

GetAppId(JwtSecurityToken)

Gets the appid from the given JWT token. This method checks the 'ver' claim to determine whether to look for the appId in the 'appid' claim (for v1 tokens) or the 'azp' claim (for v2 tokens). If the 'ver' claim is not present, it will first attempt to find the appId in the 'appid' claim and if not found, it will look in the 'azp' claim. Returns null if no suitable claim is found.

GetIncomingAudience(ClaimsIdentity)

Retrieves the Audience from the given incoming identity.

GetIncomingAudienceClaim(ClaimsIdentity)

Retrieves the Audience from the given incoming identity.

GetOutgoingAppId(ClaimsIdentity)

Gets the outgoing AppId from an incoming identity.

GetOutgoingAppIdClaim(ClaimsIdentity)

Gets the outgoing AppId from an incoming identity.

GetOutgoingAudience(ClaimsIdentity)

Retrieves the audience for an outgoing token from the given incoming identity.

GetOutgoingAudienceClaim(ClaimsIdentity)

Retrieves the audience for an outgoing token from the given incoming identity.

GetOutgoingScopes(ClaimsIdentity, Boolean)

Retrieves the token scopes from the given incoming identity.

GetOutgoingTokenScopes(ClaimsIdentity, Boolean)

Retrieves the token scopes from the given incoming identity.

GetTokenAudience(ClaimsIdentity)
Obsolete.

Retrieves the audience of the token from the given claims identity.

GetTokenScopes(ClaimsIdentity)
Obsolete.

Retrieves the token scopes from the given claims identity.

IsAgent(ClaimsIdentity)

Checks if the given incoming identity represents an Agent claim (not coming from ABS/SMBA).

IsAgentClaim(ClaimsIdentity)

Checks if the given incoming identity represents an Agent claim (not coming from ABS/SMBA).

IsBotFramework(ClaimsIdentity)

Determines whether the specified incoming identity represents a Bot Framework user.

IsBotFrameworkClaim(ClaimsIdentity)

Determines whether the specified incoming identity contains a valid Bot Framework claim.

IsExchangeableToken(JwtSecurityToken)

Determines if a token is exchangeable based on its claims. An exchangeable token is one that is not a user token and has an audience claim that contains the appId of the token.

IsGovBotFrameworkClaim(ClaimsIdentity)

Determines whether the specified incoming identity represents a government Bot Framework claim.

IsPublicBotFrameworkClaim(ClaimsIdentity)

Determines whether the specified incoming identity represents a Bot Framework claim.

Applies to