Compartilhar via


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 declarações opcionais solicitadas por um aplicativo. Um aplicativo pode configurar declarações opcionais a serem retornadas 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 token de segurança. Um aplicativo pode configurar um conjunto diferente de declarações opcionais a serem retornadas em cada tipo de token. A propriedade opcionalClaims do aplicativo é um objeto opcionalClaims .

Os desenvolvedores de aplicativos podem configurar declarações opcionais em seus aplicativos Microsoft Entra para especificar quais declarações eles desejam em tokens enviados para seu aplicativo pelo serviço de token de segurança da Microsoft. Consulte fornecer declarações opcionais ao seu aplicativo Microsoft Entra para obter mais informações.

Propriedades

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

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

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