tokenLifetimePolicy リソースの種類

[アーティクル]
09/13/2021

名前空間: microsoft.graph

jwT アクセストークン、ID トークン、または Azure Active Directory (Azure AD) によって発行された SAML 1.1/2.0 トークンの有効期間を制御できるポリシーを表します。組織のすべてのアプリ、マルチテナント (多組織) アプリケーション、組織の特定のサービスプリンシパルにトークンの有効期間を設定できます。

注: 更新トークンとセッショントークンのこのポリシーの構成はサポートされていません。

stsPolicy から継承します。

メソッド

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

プロパティ

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

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

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

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

注: これらのプロパティのすべての期間は、"dd.hh:mm:ss" という形式で指定されます。

注: "days" で示されるプロパティの最大値は、指定された日数より 1 秒短いです。たとえば、1 日の最大値は "23:59:59" として指定されます。

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

リレーションシップ

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

JSON 表記

リソースの JSON 表記を次に示します。

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