Partilhar via


optionalClaims resource type (Tipo de recurso optionalClaims)

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Declara as afirmações opcionais pedidas por uma aplicação. Uma aplicação pode configurar afirmações opcionais para serem devolvidas em cada um dos três tipos de tokens (token de ID, token de acesso, token SAML 2) que pode receber do serviço de tokens de segurança. Uma aplicação pode configurar um conjunto diferente de afirmações opcionais a serem devolvidas em cada tipo de token. A propriedade optionalClaims da aplicação é um objeto optionalClaims .

Os programadores de aplicações podem configurar afirmações opcionais nas respetivas aplicações Microsoft Entra para especificar as afirmações que pretendem em tokens enviados para a respetiva aplicação pelo serviço de tokens de segurança da Microsoft. Veja Fornecer afirmações opcionais à sua aplicação Microsoft Entra para obter mais informações.

Propriedades

Propriedade Tipo Descrição
idToken coleção optionalClaim As afirmações opcionais devolvidas no token de ID JWT.
accessToken coleção optionalClaim As afirmações opcionais devolvidas no token de acesso JWT.
saml2Token coleção optionalClaim As afirmações opcionais devolvidas no token SAML.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "idToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
  "accessToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
  "saml2Token": [{"@odata.type": "microsoft.graph.optionalClaim"}]
}