Språk

RequiredScopeAttribute Klass

Definition

Det här attributet används på en kontrollant, sidor eller kontrollant för att deklarera (och verifiera) de omfång som krävs av ett webb-API. Dessa omfång kan deklareras på två sätt: hårdkoda dem eller deklarera dem i konfigurationen. Beroende på ditt val använder du antingen den ena eller den andra av konstruktorerna. Mer information finns i 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
Arv
RequiredScopeAttribute
Attribut
Implementeringar

Konstruktorer

Name Description
RequiredScopeAttribute()

Standardkonstruktor.

RequiredScopeAttribute(String[])

Verifierar att webb-API:et anropas med rätt omfång. Om token som hämtas för det här API:et är för den autentiserade användarens räkning inte har något av dessa acceptedScopes i sitt omfångsanspråk uppdaterar metoden HTTP-svaret med statuskoden 403 (Förbjuden) och skriver till svarstexten ett meddelande som anger vilka omfång som förväntas i token.

Egenskaper

Name Description
AcceptedScope

Omfång som godkänns av det här webb-API:et.

IsReusable

Oanvänd: Kompatibilitet för gränssnittet med auktoriseringsfiltret.

RequiredScopesConfigurationKey

Fullständigt kvalificerat namn på konfigurationsnyckeln som innehåller de nödvändiga omfången (avgränsade med blanksteg).

Gäller för