Język

RequiredScopeAttribute Klasa

Definicja

Przestrzeń nazw:
Microsoft.Identity.Web.Resource
Zestaw:
Microsoft.Identity.Web.dll
Pakiet:
Microsoft.Identity.Web v4.10.0

Ten atrybut jest używany w ramach akcji kontrolera, stron lub kontrolera w celu deklarowania (i weryfikowania) zakresów wymaganych przez internetowy interfejs API. Te zakresy można zadeklarować na dwa sposoby: ich naciśnięcie lub zadeklarowanie ich w konfiguracji. W zależności od wybranego wyboru użyj jednego lub drugiego konstruktora. Aby uzyskać szczegółowe informacje, zobacz 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
Dziedziczenie
Attribute
RequiredScopeAttribute
Atrybuty
AttributeUsageAttribute
Implementuje
IAuthRequiredScopeMetadata

Konstruktory

Nazwa Opis
RequiredScopeAttribute()

Konstruktor domyślny.
RequiredScopeAttribute(String[])

Sprawdza, czy internetowy interfejs API jest wywoływany z odpowiednimi zakresami. Jeśli token uzyskany dla tego interfejsu API jest w imieniu uwierzytelnionego użytkownika nie ma żadnego z nich acceptedScopes w swoim oświadczeniu o zakresie, metoda aktualizuje odpowiedź HTTP podając kod stanu 403 (Zabronione) i zapisuje w treści odpowiedzi komunikat informujący, które zakresy są oczekiwane w tokenie.

Właściwości

Nazwa Opis
AcceptedScope

Zakresy akceptowane przez ten internetowy interfejs API.
IsReusable

Nieużywane: zgodność interfejsu z filtrem autoryzacji.
RequiredScopesConfigurationKey

W pełni kwalifikowana nazwa klucza konfiguracji zawierającego wymagane zakresy (oddzielone spacjami).

Dotyczy