optionalClaims リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

アプリケーションによって要求されるオプションのクレームを宣言します。 アプリケーションでは、セキュリティ トークン サービスから受け取ることができる 3 種類のトークン (ID トークン、アクセス トークン、SAML 2 トークン) のそれぞれで返されるオプションのクレームを構成できます。 アプリケーションでは、トークンの種類ごとに返されるオプションのクレームの異なるセットを構成できます。 アプリケーションの optionalClaims プロパティは optionalClaims オブジェクトです。

アプリケーション開発者は、Microsoft Entra アプリでオプションの要求を構成して、Microsoft セキュリティ トークン サービスによってアプリケーションに送信されるトークンで使用する要求を指定できます。 詳細については、「Microsoft Entra アプリにオプションの要求を提供する」を参照してください。

プロパティ

プロパティ 説明
idToken optionalClaim コレクション JWT ID トークンで返されるオプションのクレーム。
accessToken optionalClaim コレクション JWT アクセス トークンで返されるオプションのクレーム。
saml2Token optionalClaim コレクション SAML トークンで返されるオプションのクレーム。

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

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