tokenLifetimePolicy 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示可以控制 JWT 访问令牌、ID 令牌或由 Microsoft Entra ID 颁发的 SAML 1.1/2.0 令牌的生存期的策略。 可以为组织中的所有应用、多租户应用程序或组织中的特定服务主体设置令牌生存期。 有关方案的详细信息,请参阅Microsoft 标识平台中的可配置令牌生存期。
不支持为刷新令牌和会话令牌配置此策略。
继承自 stsPolicy。
方法
方法 | 返回类型 | Description |
---|---|---|
List | tokenLifetimePolicy | 读取 tokenLifetimePolicies 对象的属性和关系。 |
创建 | tokenLifetimePolicy | Create tokenLifetimePolicy 对象。 |
Get | tokenLifetimePolicy | 读取 tokenLifetimePolicy 对象的属性和关系。 |
更新 | 无 | 更新 tokenLifetimePolicy 对象。 |
删除 | 无 | 删除 tokenLifetimePolicy 对象。 |
列出已应用到应用程序的策略 | directoryObject collection | 获取已应用此策略的 directoryObject 列表。 |
属性
属性 | 类型 | 说明 |
---|---|---|
id | String | 此策略的唯一标识符。 此为只读属性。 |
定义 | 字符串集合 | 一个字符串集合,其中包含定义此策略的规则和设置的 JSON 字符串。 有关此属性的 JSON 架构的详细信息,请参阅 令牌生存期策略定义的属性。 必填。 |
displayName | String | 此策略的显示名称。 必填。 |
isOrganizationDefault | 布尔值 | 如果设置为 true ,则激活此策略。 同一策略类型可以有多个策略,但只有一种策略可以激活为组织默认策略。 可选,默认值为 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。 必填。 | 无 | 无 | 无 |
Relationships
关系 | 类型 | 说明 |
---|---|---|
appliesTo | directoryObject collection | 已应用此策略的 directoryObject 集合。 只读。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"definition": ["String"],
"displayName": "String",
"id": "String (identifier)",
"isOrganizationDefault": true,
}