Skip to content

Commit 2f09096

Browse files
Merge pull request #105272 from MicrosoftDocs/master
Merge master to live, 4 AM
2 parents f27b045 + 3696530 commit 2f09096

File tree

117 files changed

+398
-300
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+398
-300
lines changed

articles/active-directory-b2c/claimsschema.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: celestedg
88
ms.service: active-directory
99
ms.workload: identity
1010
ms.topic: reference
11-
ms.date: 02/17/2020
11+
ms.date: 02/24/2020
1212
ms.author: marsma
1313
ms.subservice: B2C
1414
---
@@ -171,6 +171,8 @@ The **Restriction** element contains the following elements:
171171

172172
#### Enumeration
173173

174+
The **Enumeration** element defines available options for the user to select for a claim in the user interface, such as a value in a `CheckboxMultiSelect`, `DropdownSingleSelect`, or `RadioSingleSelect`. Alternatively, you can define and localize available options with [LocalizedCollections](localization.md#localizedcollections) element. To look up an item from a claim **Enumeration** collection, use [GetMappedValueFromLocalizedCollection](string-transformations.md#getmappedvaluefromlocalizedcollection) claims transformation.
175+
174176
The **Enumeration** element contains the following attributes:
175177

176178
| Attribute | Required | Description |
@@ -243,7 +245,7 @@ The **UserInputType** element available user input types:
243245
|Paragraph | `boolean`, `date`, `dateTime`, `duration`, `int`, `long`, `string`|A field that shows text only in a paragraph tag. |
244246
|Password | `string` |Password text box.|
245247
|RadioSingleSelect |`string` | Collection of radio buttons. The claim value is the selected value.|
246-
|Readonly | `boolean`, `date`, `dateTime`, `duration`, `int`, `long`, `string`| Read only text box. |
248+
|Readonly | `boolean`, `date`, `dateTime`, `duration`, `int`, `long`, `string`| Read-only text box. |
247249
|TextBox |`boolean`, `int`, `string` |Single-line text box. |
248250

249251

@@ -403,5 +405,3 @@ The **Paragraph** user input type is used to provide a field that shows text onl
403405
</Restriction>
404406
</ClaimType>
405407
```
406-
407-
To display one of the **Enumeration** values in a **responseMsg** claim, use `GetMappedValueFromLocalizedCollection` or `CreateStringClaim` claims transformation. For more information, see [String Claims Transformations](string-transformations.md)

articles/active-directory-b2c/oauth2-technical-profile.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: celestedg
99
ms.service: active-directory
1010
ms.workload: identity
1111
ms.topic: reference
12-
ms.date: 02/13/2020
12+
ms.date: 02/24/2020
1313
ms.author: marsma
1414
ms.subservice: B2C
1515
---
@@ -93,6 +93,7 @@ The technical profile also returns claims that aren't returned by the identity p
9393
| ExtraParamsInAccessTokenEndpointResponse | No | Contains the extra parameters that can be returned in the response from **AccessTokenEndpoint** by some identity providers. For example, the response from **AccessTokenEndpoint** contains an extra parameter such as `openid`, which is a mandatory parameter besides the access_token in a **ClaimsEndpoint** request query string. Multiple parameter names should be escaped and separated by the comma ',' delimiter. |
9494
| ExtraParamsInClaimsEndpointRequest | No | Contains the extra parameters that can be returned in the **ClaimsEndpoint** request by some identity providers. Multiple parameter names should be escaped and separated by the comma ',' delimiter. |
9595
| IncludeClaimResolvingInClaimsHandling  | No | For input and output claims, specifies whether [claims resolution](claim-resolver-overview.md) is included in the technical profile. Possible values: `true`, or `false` (default). If you want to use a claims resolver in the technical profile, set this to `true`. |
96+
| ResolveJsonPathsInJsonTokens | No | Indicates whether the technical profile resolves JSON paths. Possible values: `true`, or `false` (default). Use this metadata to read data from a nested JSON element. In an [OutputClaim](technicalprofiles.md#outputclaims), set the `PartnerClaimType` to the JSON path element you want to output. For example: `firstName.localized`, or `data.0.to.0.email`.|
9697

9798
## Cryptographic keys
9899

articles/active-directory-b2c/predicates.md

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: celestedg
99
ms.service: active-directory
1010
ms.workload: identity
1111
ms.topic: reference
12-
ms.date: 10/28/2019
12+
ms.date: 02/24/2020
1313
ms.author: marsma
1414
ms.subservice: B2C
1515
---
@@ -42,12 +42,13 @@ The **Predicate** element contains the following attributes:
4242
| --------- | -------- | ----------- |
4343
| Id | Yes | An identifier that's used for the predicate. Other elements can use this identifier in the policy. |
4444
| Method | Yes | The method type to use for validation. Possible values: **IsLengthRange**, **MatchesRegex**, **IncludesCharacters**, or **IsDateRange**. The **IsLengthRange** value checks whether the length of a string claim value is within the range of minimum and maximum parameters specified. The **MatchesRegex** value checks whether a string claim value matches a regular expression. The **IncludesCharacters** value checks whether a string claim value contains a character set. The **IsDateRange** value checks whether a date claim value is between a range of minimum and maximum parameters specified. |
45+
| HelpText | No | An error message for users if the check fails. This string can be localized using the [language customization](localization.md) |
4546

4647
The **Predicate** element contains the following elements:
4748

4849
| Element | Occurrences | Description |
4950
| ------- | ----------- | ----------- |
50-
| UserHelpText | 1:1 | An error message for users if the check fails. This string can be localized using the [language customization](localization.md) |
51+
| UserHelpText | 0:1 | (Deprecated) An error message for users if the check fails. |
5152
| Parameters | 1:1 | The parameters for the method type of the string validation. |
5253

5354
The **Parameters** element contains the following elements:
@@ -65,20 +66,18 @@ The **Parameter** element contains the following attributes:
6566
The following example shows a `IsLengthRange` method with the parameters `Minimum` and `Maximum` that specify the length range of the string:
6667

6768
```XML
68-
<Predicate Id="IsLengthBetween8And64" Method="IsLengthRange">
69-
<UserHelpText>The password must be between 8 and 64 characters.</UserHelpText>
70-
<Parameters>
71-
<Parameter Id="Minimum">8</Parameter>
72-
<Parameter Id="Maximum">64</Parameter>
69+
<Predicate Id="IsLengthBetween8And64" Method="IsLengthRange" HelpText="The password must be between 8 and 64 characters.">
70+
<Parameters>
71+
<Parameter Id="Minimum">8</Parameter>
72+
<Parameter Id="Maximum">64</Parameter>
7373
</Parameters>
7474
</Predicate>
7575
```
7676

7777
The following example shows a `MatchesRegex` method with the parameter `RegularExpression` that specifies a regular expression:
7878

7979
```XML
80-
<Predicate Id="PIN" Method="MatchesRegex">
81-
<UserHelpText>The password must be numbers only.</UserHelpText>
80+
<Predicate Id="PIN" Method="MatchesRegex" HelpText="The password must be numbers only.">
8281
<Parameters>
8382
<Parameter Id="RegularExpression">^[0-9]+$</Parameter>
8483
</Parameters>
@@ -88,8 +87,7 @@ The following example shows a `MatchesRegex` method with the parameter `RegularE
8887
The following example shows a `IncludesCharacters` method with the parameter `CharacterSet` that specifies the set of characters:
8988

9089
```XML
91-
<Predicate Id="Lowercase" Method="IncludesCharacters">
92-
<UserHelpText>a lowercase letter</UserHelpText>
90+
<Predicate Id="Lowercase" Method="IncludesCharacters" HelpText="a lowercase letter">
9391
<Parameters>
9492
<Parameter Id="CharacterSet">a-z</Parameter>
9593
</Parameters>
@@ -165,7 +163,7 @@ The **PredicateGroup** element contains the following elements:
165163

166164
| Element | Occurrences | Description |
167165
| ------- | ----------- | ----------- |
168-
| UserHelpText | 1:1 | A description of the predicate that can be helpful for users to know what value they should type. |
166+
| UserHelpText | 0:1 | A description of the predicate that can be helpful for users to know what value they should type. |
169167
| PredicateReferences | 1:n | A list of predicate references. |
170168

171169
The **PredicateReferences** element contains the following attributes:
@@ -202,58 +200,50 @@ With **Predicates** and **PredicateValidationsInput** you can control the comple
202200

203201
```XML
204202
<Predicates>
205-
<Predicate Id="IsLengthBetween8And64" Method="IsLengthRange">
206-
<UserHelpText>The password must be between 8 and 64 characters.</UserHelpText>
203+
<Predicate Id="IsLengthBetween8And64" Method="IsLengthRange" HelpText="The password must be between 8 and 64 characters.">
207204
<Parameters>
208205
<Parameter Id="Minimum">8</Parameter>
209206
<Parameter Id="Maximum">64</Parameter>
210207
</Parameters>
211208
</Predicate>
212209

213-
<Predicate Id="Lowercase" Method="IncludesCharacters">
214-
<UserHelpText>a lowercase letter</UserHelpText>
210+
<Predicate Id="Lowercase" Method="IncludesCharacters" HelpText="a lowercase letter">
215211
<Parameters>
216212
<Parameter Id="CharacterSet">a-z</Parameter>
217213
</Parameters>
218214
</Predicate>
219215

220-
<Predicate Id="Uppercase" Method="IncludesCharacters">
221-
<UserHelpText>an uppercase letter</UserHelpText>
216+
<Predicate Id="Uppercase" Method="IncludesCharacters" HelpText="an uppercase letter">
222217
<Parameters>
223218
<Parameter Id="CharacterSet">A-Z</Parameter>
224219
</Parameters>
225220
</Predicate>
226221

227-
<Predicate Id="Number" Method="IncludesCharacters">
228-
<UserHelpText>a digit</UserHelpText>
222+
<Predicate Id="Number" Method="IncludesCharacters" HelpText="a digit">
229223
<Parameters>
230224
<Parameter Id="CharacterSet">0-9</Parameter>
231225
</Parameters>
232226
</Predicate>
233227

234-
<Predicate Id="Symbol" Method="IncludesCharacters">
235-
<UserHelpText>a symbol</UserHelpText>
228+
<Predicate Id="Symbol" Method="IncludesCharacters" HelpText="a symbol">
236229
<Parameters>
237230
<Parameter Id="CharacterSet">@#$%^&amp;*\-_+=[]{}|\\:',.?/`~"();!</Parameter>
238231
</Parameters>
239232
</Predicate>
240233

241-
<Predicate Id="PIN" Method="MatchesRegex">
242-
<UserHelpText>The password must be numbers only.</UserHelpText>
234+
<Predicate Id="PIN" Method="MatchesRegex" HelpText="The password must be numbers only.">
243235
<Parameters>
244236
<Parameter Id="RegularExpression">^[0-9]+$</Parameter>
245237
</Parameters>
246238
</Predicate>
247239

248-
<Predicate Id="AllowedAADCharacters" Method="MatchesRegex">
249-
<UserHelpText>An invalid character was provided.</UserHelpText>
240+
<Predicate Id="AllowedAADCharacters" Method="MatchesRegex" HelpText="An invalid character was provided.">
250241
<Parameters>
251242
<Parameter Id="RegularExpression">(^([0-9A-Za-z\d@#$%^&amp;*\-_+=[\]{}|\\:',?/`~"();! ]|(\.(?!@)))+$)|(^$)</Parameter>
252243
</Parameters>
253244
</Predicate>
254245

255-
<Predicate Id="DisallowedWhitespace" Method="MatchesRegex">
256-
<UserHelpText>The password must not begin or end with a whitespace character.</UserHelpText>
246+
<Predicate Id="DisallowedWhitespace" Method="MatchesRegex" HelpText="The password must not begin or end with a whitespace character.">
257247
<Parameters>
258248
<Parameter Id="RegularExpression">(^\S.*\S$)|(^\S+$)|(^$)</Parameter>
259249
</Parameters>
@@ -357,8 +347,7 @@ With the **Predicates** and **PredicateValidations** elements you can control th
357347

358348
```XML
359349
<Predicates>
360-
<Predicate Id="DateRange" Method="IsDateRange">
361-
<UserHelpText>The date must be between 01-01-1980 and today.</UserHelpText>
350+
<Predicate Id="DateRange" Method="IsDateRange" HelpText="The date must be between 01-01-1980 and today.">
362351
<Parameters>
363352
<Parameter Id="Minimum">1980-01-01</Parameter>
364353
<Parameter Id="Maximum">Today</Parameter>

articles/active-directory-b2c/relyingparty.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: celestedg
88
ms.service: active-directory
99
ms.workload: identity
1010
ms.topic: reference
11-
ms.date: 02/02/2020
11+
ms.date: 02/24/2020
1212
ms.author: marsma
1313
ms.subservice: B2C
1414
---
@@ -113,6 +113,7 @@ The **UserJourneyBehaviors** element contains the following elements:
113113
| SessionExpiryInSeconds | 0:1 | The lifetime of Azure AD B2C's session cookie specified as an integer stored on the user's browser upon successful authentication. |
114114
| JourneyInsights | 0:1 | The Azure Application Insights instrumentation key to be used. |
115115
| ContentDefinitionParameters | 0:1 | The list of key value pairs to be appended to the content definition load URI. |
116+
|ScriptExecution| 0:1| The supported [JavaScript](javascript-samples.md) execution modes. Possible values: `Allow` or `Disallow` (default).
116117

117118
### SingleSignOn
118119

articles/active-directory-b2c/restful-technical-profile.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: celestedg
99
ms.service: active-directory
1010
ms.workload: identity
1111
ms.topic: reference
12-
ms.date: 02/13/2020
12+
ms.date: 02/24/2020
1313
ms.author: marsma
1414
ms.subservice: B2C
1515
---
@@ -127,6 +127,7 @@ The technical profile also returns claims, that aren't returned by the identity
127127
| ClaimUsedForRequestPayload| No | Name of a string claim that contains the payload to be sent to the REST API. |
128128
| DebugMode | No | Runs the technical profile in debug mode. Possible values: `true`, or `false` (default). In debug mode, the REST API can return more information. See the [Returning error message](#returning-error-message) section. |
129129
| IncludeClaimResolvingInClaimsHandling  | No | For input and output claims, specifies whether [claims resolution](claim-resolver-overview.md) is included in the technical profile. Possible values: `true`, or `false` (default). If you want to use a claims resolver in the technical profile, set this to `true`. |
130+
| ResolveJsonPathsInJsonTokens | No | Indicates whether the technical profile resolves JSON paths. Possible values: `true`, or `false` (default). Use this metadata to read data from a nested JSON element. In an [OutputClaim](technicalprofiles.md#outputclaims), set the `PartnerClaimType` to the JSON path element you want to output. For example: `firstName.localized`, or `data.0.to.0.email`.|
130131

131132
## Cryptographic keys
132133

articles/active-directory-b2c/string-transformations.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: celestedg
99
ms.service: active-directory
1010
ms.workload: identity
1111
ms.topic: reference
12-
ms.date: 02/20/2020
12+
ms.date: 02/24/2020
1313
ms.author: marsma
1414
ms.subservice: B2C
1515
---
@@ -123,7 +123,7 @@ Creates a string claim from the provided input parameter in the transformation.
123123

124124
| Item | TransformationClaimType | Data Type | Notes |
125125
|----- | ----------------------- | --------- | ----- |
126-
| InputParameter | value | string | The string to be set |
126+
| InputParameter | value | string | The string to be set. This input parameter supports [string claims transformation expressions](string-transformations.md#string-claim-transformations-expressions). |
127127
| OutputClaim | createdClaim | string | The ClaimType that is produced after this claims transformation has been invoked, with the value specified in the input parameter. |
128128

129129
Use this claims transformation to set a string ClaimType value.
@@ -293,7 +293,7 @@ Format a claim according to the provided format string. This transformation uses
293293
| Item | TransformationClaimType | Data Type | Notes |
294294
| ---- | ----------------------- | --------- | ----- |
295295
| InputClaim | inputClaim |string |The ClaimType that acts as string format {0} parameter. |
296-
| InputParameter | stringFormat | string | The string format, including the {0} parameter. |
296+
| InputParameter | stringFormat | string | The string format, including the {0} parameter. This input parameter supports [string claims transformation expressions](string-transformations.md#string-claim-transformations-expressions). |
297297
| OutputClaim | outputClaim | string | The ClaimType that is produced after this claims transformation has been invoked. |
298298

299299
Use this claims transformation to format any string with one parameter {0}. The following example creates a **userPrincipalName**. All social identity provider technical profiles, such as `Facebook-OAUTH` calls the **CreateUserPrincipalName** to generate a **userPrincipalName**.
@@ -329,7 +329,7 @@ Format two claims according to the provided format string. This transformation u
329329
| ---- | ----------------------- | --------- | ----- |
330330
| InputClaim | inputClaim |string | The ClaimType that acts as string format {0} parameter. |
331331
| InputClaim | inputClaim | string | The ClaimType that acts as string format {1} parameter. |
332-
| InputParameter | stringFormat | string | The string format, including the {0} and {1} parameters. |
332+
| InputParameter | stringFormat | string | The string format, including the {0} and {1} parameters. This input parameter supports [string claims transformation expressions](string-transformations.md#string-claim-transformations-expressions). |
333333
| OutputClaim | outputClaim | string | The ClaimType that is produced after this claims transformation has been invoked. |
334334

335335
Use this claims transformation to format any string with two parameters, {0} and {1}. The following example creates a **displayName** with the specified format:
@@ -921,3 +921,12 @@ The following example takes a comma delimiter string of user roles, and converts
921921
- **delimiter**: ","
922922
- Output claims:
923923
- **outputClaim**: [ "Admin", "Author", "Reader" ]
924+
925+
## String claim transformations expressions
926+
Claim transformations expressions in Azure AD B2C custom policies provide context information about the tenant ID and technical profile ID.
927+
928+
| Expression | Description | Example |
929+
| ----- | ----------- | --------|
930+
| `{TechnicalProfileId}` | The technical profileId name. | Facebook-OAUTH |
931+
| `{RelyingPartyTenantId}` | The tenant ID of the relying party policy. | your-tenant.onmicrosoft.com |
932+
| `{TrustFrameworkTenantId}` | The tenant ID of the trust framework. | your-tenant.onmicrosoft.com |

0 commit comments

Comments
 (0)