Sprache

RequiredScopeAttribute Klasse

Definition

Namespace:
Microsoft.Identity.Web.Resource
Assembly:
Microsoft.Identity.Web.dll
Paket:
Microsoft.Identity.Web v4.10.0

Dieses Attribut wird für Controller-, Seiten- oder Controlleraktionen verwendet, um die von einer Web-API erforderlichen Bereiche zu deklarieren (und zu validieren). Diese Bereiche können auf zwei Arten deklariert werden: hartcodieren oder in der Konfiguration deklarieren. Verwenden Sie je nach Wahl entweder einen oder den anderen der Konstruktoren. Weitere Informationen finden Sie unter 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
Vererbung
Attribute
RequiredScopeAttribute
Attribute
AttributeUsageAttribute
Implementiert
IAuthRequiredScopeMetadata

Konstruktoren

Name Beschreibung
RequiredScopeAttribute()

Der Standardkonstruktor.
RequiredScopeAttribute(String[])

Überprüft, ob die Web-API mit den richtigen Bereichen aufgerufen wird. Wenn das für diese API abgerufene Token im Namen des authentifizierten Benutzers keines dieser acceptedScopes in seinem Bereichsanspruch hat, aktualisiert die Methode die HTTP-Antwort, die einen Statuscode 403 (Verboten) bereitstellt, und schreibt in den Antworttext eine Nachricht, die angibt, welche Bereiche im Token erwartet werden.

Eigenschaften

Name Beschreibung
AcceptedScope

Bereiche, die von dieser Web-API akzeptiert werden.
IsReusable

Nicht verwendet: Kompatibilität der Schnittstelle mit dem Autorisierungsfilter.
RequiredScopesConfigurationKey

Vollqualifizierter Name des Konfigurationsschlüssels, der die erforderlichen Bereiche enthält (durch Leerzeichen getrennt).

Gilt für: