Skip to content

Commit 19cb57d

Browse files
Yogesh Randhawayogesh-randhawa
Yogesh Randhawa
authored and
yogesh-randhawa
committed
[app mgmt policies] update docs for adding restriction state to v1 API docs
1 parent 2c7e25e commit 19cb57d

File tree

5 files changed

+78
-28
lines changed

5 files changed

+78
-28
lines changed

‎api-reference/beta/resources/keycredentialconfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Represents a key credential configuration object that contains properties to con
1919

2020
| Property | Type | Description |
2121
| :------------------------------------------ | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- |
22-
| certificateBasedApplicationConfigurationIds | String collection | Collection of GUIDs that represent [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that is allowed as root and intermediate certificate authorities.|
22+
| certificateBasedApplicationConfigurationIds | String collection | Collection of GUIDs that represent [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that is allowed as root and intermediate certificate authorities.|
2323
| maxLifetime | Duration | String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`.|
24-
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.|
24+
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.|
2525
| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.|
2626
| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.|
2727

‎api-reference/v1.0/resources/enums.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ Namespace: microsoft.graph
9999
| additionalStepsRequired |
100100
| unknownFutureValue |
101101

102+
### appManagementRestrictionState values
103+
104+
| Member |
105+
| ---- |
106+
| enabled |
107+
| disabled |
108+
| unknownFutureValue |
109+
102110
### appCredentialRestrictionType values
103111

104112
| Member |

‎api-reference/v1.0/resources/keycredentialconfiguration.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "keyCredentialConfiguration resource type"
3-
description: "Key credential configuration complex type to configure key credential restriction, maxLifetime, and enforcement date"
3+
description: "Represents a key credential configuration object that contains properties to configure application certificate restrictions."
44
ms.localizationpriority: medium
55
author: "madansr7"
66
ms.subservice: "entra-sign-in"
@@ -11,15 +11,16 @@ doc_type: resourcePageType
1111

1212
Namespace: microsoft.graph
1313

14-
Key credential configuration object that contains properties to configure restrictions such as restricting the lifetime of key secrets.
14+
Represents a key credential configuration object that contains properties to configure application certificate restriction.
1515

1616
## Properties
1717

18-
| Property | Type | Description |
19-
| :---------------------------------- | :--------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20-
| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. |
21-
| maxLifetime | Duration | Value that can be used as the maximum duration in days, hours, minutes, or seconds from the date of key creation, for which the key is valid. Defined in ISO 8601 format for Durations. For example, `P4DT12H30M5S` represents a duration of four days, twelve hours, thirty minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`. |
22-
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Timestamp when the policy is enforced for all apps created on or after the specified date. For existing applications, the enforcement date would be back dated. To apply to all applications regardless of their creation date, this property would be `null`. Nullable. |
18+
| Property | Type | Description |
19+
| :------------------------------------------ | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- |
20+
| maxLifetime | Duration | String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`.|
21+
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.|
22+
| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.|
23+
| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.|
2324

2425
## Relationships
2526

@@ -41,7 +42,10 @@ The following JSON representation shows the resource type.
4142
"restrictionType": {
4243
"@odata.type": "microsoft.graph.appKeyCredentialRestrictionType"
4344
},
44-
"maxLifetime": "String (duration)",
45-
"restrictForAppsCreatedAfterDateTime": "DateTimeOffset"
45+
"state": {
46+
"@odata.type": "microsoft.graph.appManagementRestrictionState"
47+
},
48+
"restrictForAppsCreatedAfterDateTime": "String (DateTime)",
49+
"maxLifetime": "String (duration)"
4650
}
4751
```

‎api-reference/v1.0/resources/passwordcredentialconfiguration.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Password credential configuration object that contains properties to configure r
1515

1616
## Properties
1717

18-
| Property | Type | Description |
19-
| :---------------------------------- | :--------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
20-
| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`,`customPasswordAddition`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. |
21-
| maxLifetime | Duration | Value that can be used as the maximum number for setting password expiration time in days, hours, minutes or seconds. Defined in ISO 8601 format for Durations. For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. This property is required when restriction type is set to `passwordLifetime`. |
22-
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Enforces the policy for an app created on or after the enforcement date. For existing applications, the enforcement date would be back dated. To apply to all applications, enforcement datetime would be `null`. |
18+
| Property | Type | Description |
19+
| :------------------------------------------ | :------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- |
20+
| maxLifetime | Duration | String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `passwordLifetime`.|
21+
| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.|
22+
| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`, `customPasswordAddition`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.|
23+
| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.|
2324

2425
## Relationships
2526

@@ -41,7 +42,10 @@ The following JSON representation shows the resource type.
4142
"restrictionType": {
4243
"@odata.type": "microsoft.graph.appCredentialRestrictionType"
4344
},
44-
"maxLifetime": "String (duration)",
45-
"restrictForAppsCreatedAfterDateTime": "DateTimeOffset"
45+
"state": {
46+
"@odata.type": "microsoft.graph.appManagementRestrictionState"
47+
},
48+
"restrictForAppsCreatedAfterDateTime": "String (DateTime)",
49+
"maxLifetime": "String (duration)"
4650
}
4751
```

‎changelog/Microsoft.DirectoryServices.json

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,50 @@
11
{
22
"changelog": [
33
{
4-
"ChangeList": [
5-
{
6-
"Id": "c6f4eb0f-746a-4a71-827e-da8585b89c64",
7-
"ApiChange": "Resource",
8-
"ChangedApiName": "user",
9-
"ChangeType": "Change",
10-
"Description": "Changed the following on-prem synced properties of the [user](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-beta) resource type that were read-only in Microsoft Graph to be updatable via Microsoft Graph: **onPremisesDistinguishedName**, **onPremisesDomainName**, **onPremisesSamAccountName**, **onPremisesSecurityIdentifier**, **onPremisesUserPrincipalName**.",
11-
"Target": "user"
12-
}
13-
],
4+
"ChangeList": [
5+
{
6+
"Id": "33b75f19-78a3-418c-9698-d2b60a6af88a",
7+
"ApiChange": "Enumeration",
8+
"ChangedApiName": "appManagementRestrictionState",
9+
"ChangeType": "Addition",
10+
"Description": "Added the **appManagementRestrictionState** enumeration type.",
11+
"Target": "appManagementRestrictionState"
12+
},
13+
{
14+
"Id": "33b75f19-78a3-418c-9698-d2b60a6af88a",
15+
"ApiChange": "Property",
16+
"ChangedApiName": "state",
17+
"ChangeType": "Addition",
18+
"Description": "Added the **state** property to the [keyCredentialConfiguration](https://learn.microsoft.com/en-us/graph/api/resources/keyCredentialConfiguration?view=graph-rest-1.0) resource.",
19+
"Target": "keyCredentialConfiguration"
20+
},
21+
{
22+
"Id": "33b75f19-78a3-418c-9698-d2b60a6af88a",
23+
"ApiChange": "Property",
24+
"ChangedApiName": "state",
25+
"ChangeType": "Addition",
26+
"Description": "Added the **state** property to the [passwordCredentialConfiguration](https://learn.microsoft.com/en-us/graph/api/resources/passwordCredentialConfiguration?view=graph-rest-1.0) resource.",
27+
"Target": "passwordCredentialConfiguration"
28+
}
29+
],
30+
"Id": "33b75f19-78a3-418c-9698-d2b60a6af88a",
31+
"Cloud": "Prod",
32+
"Version": "v1.0",
33+
"CreatedDateTime": "2024-11-01T22:52:30.5735697Z",
34+
"WorkloadArea": "Identity and access",
35+
"SubArea": "Directory management"
36+
},
37+
{
38+
"ChangeList": [
39+
{
40+
"Id": "c6f4eb0f-746a-4a71-827e-da8585b89c64",
41+
"ApiChange": "Resource",
42+
"ChangedApiName": "user",
43+
"ChangeType": "Change",
44+
"Description": "Changed the following on-prem synced properties of the [user](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-beta) resource type that were read-only in Microsoft Graph to be updatable via Microsoft Graph: **onPremisesDistinguishedName**, **onPremisesDomainName**, **onPremisesSamAccountName**, **onPremisesSecurityIdentifier**, **onPremisesUserPrincipalName**.",
45+
"Target": "user"
46+
}
47+
],
1448
"Id": "c6f4eb0f-746a-4a71-827e-da8585b89c64",
1549
"Cloud": "Prod",
1650
"Version": "beta",

0 commit comments

Comments
 (0)