Langue

RequiredScopeAttribute Classe

Définition

Espace de noms:
Microsoft.Identity.Web.Resource
Assembly:
Microsoft.Identity.Web.dll
Package:
Microsoft.Identity.Web v4.16.1

Cet attribut est utilisé sur un contrôleur, des pages ou des actions de contrôleur pour déclarer (et valider) les étendues requises par une API web. Ces étendues peuvent être déclarées de deux façons : les coder en dur ou les déclarer dans la configuration. Selon votre choix, utilisez l’un ou l’autre des constructeurs. Pour plus d’informations, consultez https://aka.ms/ms-id-web/required-scope-attribute.

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)]
public class RequiredScopeAttribute : Attribute, Microsoft.Identity.Web.IAuthRequiredScopeMetadata
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)>]
type RequiredScopeAttribute = class
    inherit Attribute
    interface IAuthRequiredScopeMetadata
Public Class RequiredScopeAttribute
Inherits Attribute
Implements IAuthRequiredScopeMetadata
Héritage
Attribute
RequiredScopeAttribute
Attributs
AttributeUsageAttribute
Implémente
IAuthRequiredScopeMetadata

Constructeurs

Nom Description
RequiredScopeAttribute()

Constructeur par défaut.
RequiredScopeAttribute(String[])

Vérifie que l’API web est appelée avec les étendues appropriées. Si le jeton obtenu pour cette API est au nom de l’utilisateur authentifié n’en a acceptedScopes pas dans sa revendication d’étendue, la méthode met à jour la réponse HTTP fournissant un code d’état 403 (Interdit) et écrit dans le corps de la réponse un message indiquant quelles étendues sont attendues dans le jeton.

Propriétés

Nom Description
AcceptedScope

Étendues acceptées par cette API web.
IsReusable

Inutilisé : compatibilité de l’interface avec le filtre d’autorisation.
RequiredScopesConfigurationKey

Nom complet de la clé de configuration contenant les étendues requises (séparées par des espaces).

S’applique à