Skip to content

Commit f96f668

Browse files
authored
Merge pull request #25747 from microsoftgraph/nickludwig-patch-1
Update graph beta documentation for Flexible FIC release
2 parents 00a1dcd + 0a93a32 commit f96f668

File tree

5 files changed

+89
-6
lines changed

5 files changed

+89
-6
lines changed

api-reference/beta/api/federatedidentitycredential-get.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "nickludwig"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-applications"
77
doc_type: apiPageType
8-
ms.date: 04/05/2024
8+
ms.date: 12/03/2024
99
---
1010

1111
# Get federatedIdentityCredential
@@ -127,7 +127,8 @@ Content-Type: application/json
127127
"description": "This is my test federated identity credential",
128128
"audiences": [
129129
"api://AzureADTokenExchange"
130-
]
130+
],
131+
"claimsMatchingExpression": null
131132
}
132133
}
133134
```

api-reference/beta/api/federatedidentitycredential-update.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "nickludwig"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-applications"
77
doc_type: apiPageType
8-
ms.date: 04/05/2024
8+
ms.date: 12/03/2024
99
---
1010

1111
# Update federatedIdentityCredential
@@ -132,5 +132,4 @@ Content-Type: application/json
132132
-->
133133
``` http
134134
HTTP/1.1 204 No Content
135-
136135
```

api-reference/beta/resources/federatedidentitycredential.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.localizationpriority: medium
66
ms.subservice: "entra-applications"
77
doc_type: resourcePageType
88
toc.keywords: [ Workload identity federation, workload identities ]
9-
ms.date: 07/22/2024
9+
ms.date: 12/03/2024
1010
---
1111

1212
# federatedIdentityCredential resource type
@@ -34,13 +34,16 @@ Inherits from [entity](../resources/entity.md).
3434
|Property|Type|Description|
3535
|:---|:---|:---|
3636
| audiences | String collection | The audience that can appear in the external token. This field is mandatory and should be set to `api://AzureADTokenExchange` for Microsoft Entra ID. It says what Microsoft identity platform should accept in the `aud` claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required. |
37+
| claimsMatchingExpression |[federatedIdentityExpression](../resources/federatedidentityexpression.md)| Enables the use of claims matching expressions against specified claims. For the list of supported expression syntax and claims, visit the [Flexible FIC reference](https://aka.ms/flexiblefic). |
3738
| description | String | The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional. |
3839
| id| String | The unique identifier for the federated identity. Required. Read-only. |
3940
| issuer | String | The URL of the external identity provider and must match the `issuer` claim of the external token being exchanged. The combination of the values of **issuer** and **subject** must be unique on the app. It has a limit of 600 characters. Required. |
4041
| name | String | The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Alternate key. Required. Not nullable. Supports `$filter` (`eq`). |
4142
| subject | String | Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the `sub` claim within the token presented to Microsoft Entra ID. The combination of **issuer** and **subject** must be unique on the app. It has a limit of 600 characters. Supports `$filter` (`eq`). |
4243

4344

45+
46+
4447
## Relationships
4548

4649
None
@@ -59,12 +62,16 @@ The following JSON representation shows the resource type.
5962
``` json
6063
{
6164
"@odata.type": "#microsoft.graph.federatedIdentityCredential",
65+
"id": "String (identifier)",
6266
"name": "String",
6367
"issuer": "String",
6468
"subject": "String",
6569
"description": "String",
6670
"audiences": [
6771
"String"
68-
]
72+
],
73+
"claimsMatchingExpression": {
74+
"@odata.type": "microsoft.graph.federatedIdentityExpression"
75+
}
6976
}
7077
```
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "federatedIdentityExpression resource type"
3+
description: "Enables configuration for flexible federated identity credential matching through the claimsMatchingExpression property of the federatedIdentityCredential resource type."
4+
author: "nickludwig"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-applications"
7+
doc_type: resourcePageType
8+
ms.date: 12/03/2024
9+
---
10+
11+
# federatedIdentityExpression resource type
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Enables the use of a restricted expression language for flexible matching of federated identity credentials to workload scenarios. Primarily, this resource type allows the specification of wildcard-based expressions within **claimsMatchingExpression** property of [federatedIdentityCredential resource type](../resources/federatedidentitycredential.md) > **value** property. For more information on supported patterns and scenarios, visit the [flexible federated identity credentials documentation](https://aka.ms/flexiblefic).
18+
19+
20+
## Properties
21+
|Property|Type|Description|
22+
|:---|:---|:---|
23+
|languageVersion|Int32|Indicated the language version to be used. Should always be set to 1. Required.|
24+
|value|String|Indicates the configured expression. Required.|
25+
26+
## Relationships
27+
None.
28+
29+
## JSON representation
30+
The following JSON representation shows the resource type.
31+
<!-- {
32+
"blockType": "resource",
33+
"@odata.type": "microsoft.graph.federatedIdentityExpression"
34+
}
35+
-->
36+
``` json
37+
{
38+
"@odata.type": "#microsoft.graph.federatedIdentityExpression",
39+
"languageVersion": "Integer",
40+
"value": "String"
41+
}
42+
```

changelog/Microsoft.DirectoryServices.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7290,6 +7290,40 @@
72907290
"WorkloadArea": "Identity and access",
72917291
"SubArea": "Governance"
72927292
},
7293+
{
7294+
"ChangeList": [
7295+
{
7296+
"Id": "a7cfb7c0-e9b2-4bd9-a964-0c5cb902b29e",
7297+
"ApiChange": "Resource",
7298+
"ChangedApiName": "federatedIdentityExpression",
7299+
"ChangeType": "Addition",
7300+
"Description": "Added the [federatedIdentityExpression](https://learn.microsoft.com/en-us/graph/api/resources/federatedIdentityExpression?view=graph-rest-beta) resource.",
7301+
"Target": "federatedIdentityExpression"
7302+
},
7303+
{
7304+
"Id": "a7cfb7c0-e9b2-4bd9-a964-0c5cb902b29e",
7305+
"ApiChange": "Property",
7306+
"ChangedApiName": "claimsMatchingExpression",
7307+
"ChangeType": "Addition",
7308+
"Description": "Added the **claimsMatchingExpression** property to the [federatedIdentityCredential](https://learn.microsoft.com/en-us/graph/api/resources/federatedIdentityCredential?view=graph-rest-beta) resource.",
7309+
"Target": "federatedIdentityCredential"
7310+
},
7311+
{
7312+
"Id": "a7cfb7c0-e9b2-4bd9-a964-0c5cb902b29e",
7313+
"ApiChange": "Property",
7314+
"ChangedApiName": "subject",
7315+
"ChangeType": "Change",
7316+
"Description": "Changed the **subject** property of the [federatedIdentityCredential](https://learn.microsoft.com/en-us/graph/api/resources/federatedIdentityCredential?view=graph-rest-beta) resource from explicitly required. If the **claimsMatchingExpression** property for supporting flexible federated identity credentials is configured, this property must be empty.",
7317+
"Target": "federatedIdentityCredential"
7318+
}
7319+
],
7320+
"Id": "a7cfb7c0-e9b2-4bd9-a964-0c5cb902b29e",
7321+
"Cloud": "Prod",
7322+
"Version": "beta",
7323+
"CreatedDateTime": "2024-12-11T20:23:12.4964215Z",
7324+
"WorkloadArea": "Applications",
7325+
"SubArea": ""
7326+
},
72937327
{
72947328
"ChangeList": [
72957329
{

0 commit comments

Comments
 (0)