Skip to content

Refactor data type documentation #5647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 20, 2025
Merged

Refactor data type documentation #5647

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d11aaea
Refactor data type documentation
sadilchamishka Oct 17, 2025
48345e9
Refactor data type documentation
sadilchamishka Oct 17, 2025
810aac9
Refactor data type documentation
sadilchamishka Oct 17, 2025
513ac8c
Update en/includes/guides/users/attributes/manage-attributes.md
sadilchamishka Oct 17, 2025
ce11553
Fix vale failures
sadilchamishka Oct 17, 2025
087b1d9
Fix vale failures
sadilchamishka Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 44 additions & 13 deletions en/includes/guides/users/attributes/manage-attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,17 +265,48 @@

5. Attribute Data Types.

An attribute can be of one of the following data types:

- **Text** A plain string value.
- **Options** A pre-defined list of selectable values.
- **Integer** Whole numbers (for example `1`, `42`, `-7`).
- **Decimal** Numbers that include decimals (for example `3.14`, `-0.5`).
- **Boolean** A true or false value.
- **Object** A structured object that can include multiple sub-attributes.
- **Date** Calendar date without time. Use ISO 8601 `YYYY-MM-DD` (for example `2025-10-01`).
- **DateTime** Date and time with timezone. Use ISO 8601 `YYYY-MM-DDTHH:mm:ssZ` or offset `YYYY-MM-DDTHH:mm:ss±HH:mm` (for example `2025-10-01T14:30:00+05:30`).
- **Epoch** Unix time since 1970-01-01 UTC. Use seconds or milliseconds as integers (for example `1730399400` or `1730399400000`).
An attribute supports one of the following data types:

<table>
<tbody>
<tr>
<td><b>Text</b></td>
<td>A plain string value.</td>
</tr>
<tr>
<td><b>Options</b></td>
<td>A pre-defined list of selectable values.</td>
</tr>
<tr>
<td><b>Integer</b></td>
<td>Whole numbers (for example <code>1</code>, <code>42</code>, <code>-7</code>).</td>
</tr>
<tr>
<td><b>Decimal</b></td>
<td>Numbers that include decimals (for example <code>3.14</code>, <code>-0.5</code>).</td>
</tr>
<tr>
<td><b>Boolean</b></td>
<td>A true or false value.</td>
</tr>
<tr>
<td><b>Object</b></td>
<td>A structured object that can include several sub-attributes.</td>

Check warning on line 294 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.Weasel] 'several' is a weasel word!

Raw Output:
{"message": "[write-good.Weasel] 'several' is a weasel word!", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 294, "column": 58}}}, "severity": "WARNING"}
</tr>
<tr>
<td><b>Date</b></td>
<td>Calendar date without time. Use ISO 8601 <code>YYYY-MM-DD</code> (for example <code>2025-10-01</code>).</td>

Check warning on line 298 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'ISO' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'ISO' has no definition.", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 298, "column": 53}}}, "severity": "INFO"}
</tr>
<tr>
<td><b>DateTime</b></td>
<td>Date and time with timezone. Use ISO 8601 <code>YYYY-MM-DDTHH&#58;mm&#58;ssZ</code> or offset <code>YYYY-MM-DDTHH&#58;mm&#58;ss±HH&#58;mm</code> (for example <code>2025-10-01T14:30:00+05:30</code>).</td>

Check warning on line 302 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'ISO' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'ISO' has no definition.", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 302, "column": 54}}}, "severity": "INFO"}
</tr>
<tr>
<td><b>Epoch</b></td>
<td>Unix time since 1970-01-01 UTC. Use seconds or milliseconds as integers (for example <code>1730399400</code> or <code>1730399400000</code>).</td>
</tr>
</tbody>
</table>

Options Data Type

Expand All @@ -290,12 +321,12 @@

If an attribute needs to hold a structured object, use the **Object** data type and configure its **sub-attributes**.

![SubAttributes for attributes]({{base_path}}/assets/img/guides/organization/attributes/edit-addtribute-sub-attributes.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

Check warning on line 324 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Semicolon] Try to simplify this sentence.

Raw Output:
{"message": "[Microsoft.Semicolon] Try to simplify this sentence.", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 324, "column": 164}}}, "severity": "INFO"}

!!! note
The following constraints apply if there is a mapped SCIM claim for the attribute:
The following constraints apply if there is a mapped SCIM attribute for the attribute:

Check warning on line 327 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SCIM' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'SCIM' has no definition.", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 327, "column": 62}}}, "severity": "INFO"}

Check warning on line 327 in en/includes/guides/users/attributes/manage-attributes.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'is'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "en/includes/guides/users/attributes/manage-attributes.md", "range": {"start": {"line": 327, "column": 50}}}, "severity": "INFO"}

1. Each sub-attribute SCIM claim must start with the main attribute name followed by a dot (`.`)
1. Each sub-attribute of the mapped SCIM attribute must start with the main attribute name followed by a dot (`.`)
and a descriptive sub-attribute name.

2. You can't assign another attribute of type **Object** as a sub-attribute.
Expand Down
Loading