tokenLifetimePolicy リソースの種類

[アーティクル]
02/07/2024

名前空間: microsoft.graph

MICROSOFT ENTRA IDによって発行された JWT アクセストークン、ID トークン、または SAML 1.1/2.0 トークンの有効期間を制御できるポリシーを表します。 organization内のすべてのアプリ、マルチテナント (マルチorganization) アプリケーション、またはorganizationの特定のサービスプリンシパルに対してトークンの有効期間を設定できます。シナリオの詳細については、Microsoft ID プラットフォームの構成可能なトークンの有効期間に関するページを参照してください。

更新トークンとセッショントークンに対してこのポリシーを構成することはサポートされていません。

stsPolicy から継承します。

メソッド

メソッド	戻り値の型	説明
tokenLifetimePolicy を一覧表示する	tokenLifetimePolicy	tokenLifetimePolicies オブジェクトのプロパティとリレーションシップを読み取ります。
tokenLifetimePolicy を作成する	tokenLifetimePolicy	tokenLifetimePolicy オブジェクトを作成します。
tokenLifetimePolicy を取得する	tokenLifetimePolicy	tokenLifetimePolicy オブジェクトのプロパティとリレーションシップを読み取ります。
tokenLifetimePolicy を更新する	なし	tokenLifetimePolicy オブジェクトを更新します。
tokenLifetimePolicy を削除する	なし	tokenLifetimePolicy オブジェクトを削除します。
appliesTo の一覧	directoryObject コレクション	このポリシーが適用されている directoryObjects の一覧を取得します。

プロパティ

プロパティ	型	説明
definition	String collection	このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。このプロパティの JSON スキーマの詳細については、「トークンの有効期間ポリシー定義のプロパティ」を参照してください。必須です。
displayName	String	このポリシーの表示名。必須。
id	String	このポリシーの一意識別子。読み取り専用。
isOrganizationDefault	ブール型	に設定すると `true`、このポリシーがアクティブになります。同じポリシーの種類に対して多数のポリシーを使用できますが、organizationの既定値としてアクティブ化できるのは 1 つだけです。省略可能です。既定値はです `false`。

トークンの有効期間ポリシー定義のプロパティ

次の JSON オブジェクトは、トークンの有効期間ポリシー定義プロパティのプロパティを示しています。この JSON オブジェクトは、例に示すように 、引用符がエスケープされた文字列に変換 して 、定義 プロパティに挿入する必要があります。

"definition": [
    "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"8:00:00\"}}"
  ]

注:

これらのプロパティのすべての期間は、"dd.hh:mm:ss" 形式で指定されます。 "日数" で示されるプロパティの最大値は、示された日数の 1 秒足りない値です。たとえば、1 日の最大値は "23:59:59" として指定されます。

プロパティ	型	説明	最小値	最大値	既定値
AccessTokenLifetime	String	アクセストークンと ID トークンの両方が有効と見なされる期間を制御します。	10 分	1 日	1 時間
バージョン	整数	値を 1 に設定します。必須です。	なし	なし	なし

関係

リレーションシップ	型	説明
Appliesto	directoryObject コレクション	このポリシーが適用されている directoryObject コレクション。読み取り専用。

JSON 表記

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

{
  "definition": ["String"],
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true,
}