Skip to content

Commit af71621

Browse files
authored
Merge pull request #104567 from yoelhor/patch-7
Update claimsschema.md
2 parents 8326f35 + 4a0ad10 commit af71621

File tree

1 file changed

+48
-15
lines changed

1 file changed

+48
-15
lines changed

articles/active-directory-b2c/claimsschema.md

Lines changed: 48 additions & 15 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/12/2020
11+
ms.date: 02/17/2020
1212
ms.author: marsma
1313
ms.subservice: B2C
1414
---
@@ -47,14 +47,32 @@ The **ClaimType** element contains the following elements:
4747
| Element | Occurrences | Description |
4848
| ------- | ----------- | ----------- |
4949
| DisplayName | 1:1 | The title that's displayed to users on various screens. The value can be [localized](localization.md). |
50-
| DataType | 1:1 | The type of the claim. The data types of boolean, date, dateTime, int, long, string, stringCollection and phoneNumber can be used. Primitive data type represents the equivalent of C# variable data type. stringCollection represents a collection of strings. For more information see [C# Types and variables](https://docs.microsoft.com/dotnet/csharp/tour-of-csharp/types-and-variables). Date follows ISO 8601 convention. |
50+
| DataType | 1:1 | The type of the claim. |
5151
| DefaultPartnerClaimTypes | 0:1 | The partner default claim types to use for a specified protocol. The value can be overwritten in the **PartnerClaimType** specified in the **InputClaim** or **OutputClaim** elements. Use this element to specify the default name for a protocol. |
5252
| Mask | 0:1 | An optional string of masking characters that can be applied when displaying the claim. For example, the phone number 324-232-4343 can be masked as XXX-XXX-4343. |
5353
| UserHelpText | 0:1 | A description of the claim type that can be helpful for users to understand its purpose. The value can be [localized](localization.md). |
5454
| UserInputType | 0:1 | The type of input control that should be available to the user when manually entering the claim data for the claim type. See the user input types defined later in this page. |
5555
| Restriction | 0:1 | The value restrictions for this claim, such as a regular expression (Regex) or a list of acceptable values. The value can be [localized](localization.md). |
5656
PredicateValidationReference| 0:1 | A reference to a **PredicateValidationsInput** element. The **PredicateValidationReference** elements enable you to perform a validation process to ensure that only properly formed data is entered. For more information, see [Predicates](predicates.md). |
5757

58+
### DataType
59+
60+
The **DataType** element supports the following values:
61+
62+
| Type | Description |
63+
| ------- | ----------- |
64+
|boolean|Represents a Boolean (`true` or `false`) value.|
65+
|date| Represents an instant in time, typically expressed as a date of a day. The value of the date follows ISO 8601 convention.|
66+
|dateTime|Represents an instant in time, typically expressed as a date and time of day. The value of the date follows ISO 8601 convention.|
67+
|duration|Represents a time interval in years, months, days, hours, minutes, and seconds. The format of is `PnYnMnDTnHnMnS`, where `P` indicates positive, or `N` for negative value. `nY` is the number of years followed by a literal `Y`. `nMo` is the number of months followed by a literal `Mo`. `nD` is the number of days followed by a literal `D`. Examples: `P21Y` represents 21 years. `P1Y2Mo` represents one year, and two months. `P1Y2Mo5D` represents one year, two months, and five days. `P1Y2M5DT8H5M620S` represents one year, two months, five days, eight hours, five minutes, and twenty seconds. |
68+
|phoneNumber|Represents a phone number. |
69+
|int| Represents number between -2,147,483,648 and 2,147,483,647|
70+
|long| Represents number between -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 |
71+
|string| Represents text as a sequence of UTF-16 code units.|
72+
|stringCollection|Represents a collection of `string`.|
73+
|userIdentity| Represents a user identity.|
74+
|userIdentityCollection|Represents a collection of `userIdentity`.|
75+
5876
### DefaultPartnerClaimTypes
5977

6078
The **DefaultPartnerClaimTypes** may contain the following element:
@@ -151,7 +169,7 @@ The **Restriction** element contains the following elements:
151169
| Enumeration | 1:n | The available options in the user interface for the user to select for a claim, such as a value in a dropdown. |
152170
| Pattern | 1:1 | The regular expression to use. |
153171

154-
### Enumeration
172+
#### Enumeration
155173

156174
The **Enumeration** element contains the following attributes:
157175

@@ -210,11 +228,26 @@ The Identity Experience Framework renders the email address claim with email for
210228

211229
![TextBox showing error message triggered by regex restriction](./media/claimsschema/pattern.png)
212230

213-
## UserInputType
231+
### UserInputType
232+
233+
Azure AD B2C supports a variety of user input types, such as a textbox, password, and dropdown list that can be used when manually entering claim data for the claim type. You must specify the **UserInputType** when you collect information from the user by using a [self-asserted technical profile](self-asserted-technical-profile.md) and [display controls](display-controls.md).
234+
235+
The **UserInputType** element available user input types:
236+
237+
| UserInputType | Supported ClaimType | Description |
238+
| --------- | -------- | ----------- |
239+
|CheckboxMultiSelect| `string` |Multi select drop-down box. The claim value is represented in a comma delimiter string of the selected values. |
240+
|DateTimeDropdown | `date`, `dateTime` |Drop-downs to select a day, month, and year. |
241+
|DropdownSingleSelect |`string` |Single select drop-down box. The claim value is the selected value.|
242+
|EmailBox | `string` |Email input field. |
243+
|Paragraph | `boolean`, `date`, `dateTime`, `duration`, `int`, `long`, `string`|A field that shows text only in a paragraph tag. |
244+
|Password | `string` |Password text box.|
245+
|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. |
247+
|TextBox |`boolean`, `int`, `string` |Single-line text box. |
214248

215-
Azure AD B2C supports a variety of user input types, such as a textbox, password, and dropdown list that can be used when manually entering claim data for the claim type. You must specify the **UserInputType** when you collect information from the user by using a [self-asserted technical profile](self-asserted-technical-profile.md).
216249

217-
### TextBox
250+
#### TextBox
218251

219252
The **TextBox** user input type is used to provide a single-line text box.
220253

@@ -229,7 +262,7 @@ The **TextBox** user input type is used to provide a single-line text box.
229262
</ClaimType>
230263
```
231264

232-
### EmailBox
265+
#### EmailBox
233266

234267
The **EmailBox** user input type is used to provide a basic email input field.
235268

@@ -247,7 +280,7 @@ The **EmailBox** user input type is used to provide a basic email input field.
247280
</ClaimType>
248281
```
249282

250-
### Password
283+
#### Password
251284

252285
The **Password** user input type is used to record a password entered by the user.
253286

@@ -262,7 +295,7 @@ The **Password** user input type is used to record a password entered by the use
262295
</ClaimType>
263296
```
264297

265-
### DateTimeDropdown
298+
#### DateTimeDropdown
266299

267300
The **DateTimeDropdown** user input type is used to provide a set of drop-downs to select a day, month, and year. You can use Predicates and PredicateValidations elements to control the minimum and maximum date values. For more information, see the **Configure a date range** section of [Predicates and PredicateValidations](predicates.md).
268301

@@ -277,7 +310,7 @@ The **DateTimeDropdown** user input type is used to provide a set of drop-downs
277310
</ClaimType>
278311
```
279312

280-
### RadioSingleSelect
313+
#### RadioSingleSelect
281314

282315
The **RadioSingleSelect** user input type is used to provide a collection of radio buttons that allows the user to select one option.
283316

@@ -296,7 +329,7 @@ The **RadioSingleSelect** user input type is used to provide a collection of rad
296329
</ClaimType>
297330
```
298331

299-
### DropdownSingleSelect
332+
#### DropdownSingleSelect
300333

301334
The **DropdownSingleSelect** user input type is used to provide a drop-down box that allows the user to select one option.
302335

@@ -315,7 +348,7 @@ The **DropdownSingleSelect** user input type is used to provide a drop-down box
315348
</ClaimType>
316349
```
317350

318-
### CheckboxMultiSelect
351+
#### CheckboxMultiSelect
319352

320353
The **CheckboxMultiSelect** user input type is used to provide a collection of checkboxes that allows the user to select multiple options.
321354

@@ -334,7 +367,7 @@ The **CheckboxMultiSelect** user input type is used to provide a collection of c
334367
</ClaimType>
335368
```
336369

337-
### Readonly
370+
#### Readonly
338371

339372
The **Readonly** user input type is used to provide a readonly field to display the claim and value.
340373

@@ -350,9 +383,9 @@ The **Readonly** user input type is used to provide a readonly field to display
350383
```
351384

352385

353-
### Paragraph
386+
#### Paragraph
354387

355-
The **Paragraph** user input type is used to provide a field that shows text only in a paragraph tag. For example, &lt;p&gt;text&lt;/p&gt;.
388+
The **Paragraph** user input type is used to provide a field that shows text only in a paragraph tag. For example, &lt;p&gt;text&lt;/p&gt;. A **Paragraph** user input type `OutputClaim` of self-asserted technical profile, must set the `Required` attribute `false` (default).
356389

357390
![Using claim type with paragraph](./media/claimsschema/paragraph.png)
358391

0 commit comments

Comments
 (0)