tokenLifetimePolicy リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
Azure Active Directory (Azure AD) によって発行された JWT アクセス トークン、ID トークン、または SAML 1.1/2.0 トークンの有効期間を制御できるポリシーを表します。 組織のすべてのアプリ、マルチテナント (多組織) アプリケーション、組織の特定のサービス プリンシパルにトークンの有効期間を設定できます。 シナリオの詳細については 、「Azure Active Directory で構成可能なトークンの有効期間」を参照してください。
注: 更新トークンとセッション トークンのこのポリシーの構成はサポートされていません。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| create tokenLifetimePolicy | tokenLifetimePolicy | tokenLifetimePolicy オブジェクトを作成します。 |
| get tokenLifetimePolicy | tokenLifetimePolicy | tokenLifetimePolicy オブジェクトのプロパティとリレーションシップを読み取る。 |
| tokenLifetimePolicy を一覧表示する | tokenLifetimePolicy | tokenLifetimePolicies オブジェクトのプロパティとリレーションシップを読み取る。 |
| update tokenLifetimePolicy | なし | tokenLifetimePolicy オブジェクトを更新します。 |
| delete tokenLifetimePolicy | なし | tokenLifetimePolicy オブジェクトを削除します。 |
| List appliesTo | directoryObject collection | このポリシーが適用されている directoryObjects の一覧を取得します。 |
| tokenLifetimePolicy を割り当てる | なし | tokenLifetimePolicy オブジェクトをアプリケーションまたは servicePrincipal オブジェクトに割り当てる。 |
| 割り当てられた tokenLifetimePolicy の一覧 | tokenLifetimePolicy コレクション | アプリケーションまたは servicePrincipal オブジェクトに割り当てられているtokenLifetimePolicy オブジェクトを一覧表示します。 |
| tokenLifetimePolicy を削除する | なし | アプリケーションまたは servicePrincipal オブジェクトからtokenLifetimePolicy オブジェクトを削除します。 |
Properties
| プロパティ | 種類 | 説明 |
|---|---|---|
| id | 文字列 | このポリシーの一意の識別子。 読み取り専用。 |
| definition | String collection | このポリシーのルールと設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、以下を参照してください。 必須です。 |
| 説明 | String | このポリシーの説明。 |
| displayName | 文字列 | このポリシーの表示名。 必須です。 |
| isOrganizationDefault | ブール型 | に設定すると 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 | 文字列 | アクセス トークンと ID トークンの両方が有効と見なされる期間を制御します。 | 10 分 | 1 日 | 1 時間 |
| バージョン | 整数 | 1 の値を設定します。 必須です。 | なし | なし | なし |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| appliesTo | directoryObject collection | この ポリシーが 適用された directoryObject コレクション。 読み取り専用。 |
JSON 表記
リソースの JSON 表記を次に示します。
{
"definition": ["String"],
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"isOrganizationDefault": true,
}
フィードバック
フィードバックの送信と表示