Idioma

RequiredScopeAttribute Classe

Definição

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

Esse atributo é usado em um controlador, páginas ou ações do controlador para declarar (e validar) os escopos exigidos por uma API Web. Esses escopos podem ser declarados de duas maneiras: codificar ou declará-los na configuração. Dependendo de sua escolha, use um ou outro dos construtores. Para obter detalhes, consulte 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
Herança
Attribute
RequiredScopeAttribute
Atributos
AttributeUsageAttribute
Implementações
IAuthRequiredScopeMetadata

Construtores

Nome Description
RequiredScopeAttribute()

Construtor padrão.
RequiredScopeAttribute(String[])

Verifica se a API Web é chamada com os escopos corretos. Se o token obtido para essa API estiver em nome do usuário autenticado não tiver nenhum deles acceptedScopes em sua declaração de escopo, o método atualizará a resposta HTTP fornecendo um código de status 403 (Proibido) e gravará no corpo da resposta uma mensagem informando quais escopos são esperados no token.

Propriedades

Nome Description
AcceptedScope

Escopos aceitos por essa API Web.
IsReusable

Não utilizado: Compatibilidade da interface com o Filtro de Autorização.
RequiredScopesConfigurationKey

Nome totalmente qualificado da chave de configuração que contém os escopos necessários (separados por espaços).

Aplica-se a