Skip to content

Document optional SCIM mailNickname fallback #2071

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
Regan Downer (v-regandowner) merged 1 commit into from
Aug 27, 2026
+10 −11
Merged

Document optional SCIM mailNickname fallback #2071

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 10 additions & 11 deletions docs/identity/app-provisioning/entra-id-scim-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ manager: pmwongera
ms.service: entra-id
ms.subservice: app-provisioning
ms.topic: how-to
ms.date: 04/07/2026
ms.date: 08/12/2026
ms.reviewer: chmutali
ai-usage: ai-assisted

Expand Down Expand Up @@ -158,11 +158,11 @@ Response is truncated for readability.
"schemaExtensions": [
{
"schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"required": true
"required": false
},
{
"schema": "urn:ietf:params:scim:schemas:extension:Microsoft:Entra:2.0:User",
"required": true
"required": false
}
],
"meta": {
Expand Down Expand Up @@ -217,7 +217,7 @@ Response is truncated for readability.
"schemaExtensions": [
{
"schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"required": true
"required": false
}
],
Comment on lines 217 to 222
"meta": {
Expand Down Expand Up @@ -735,7 +735,8 @@ The following attributes are required for successful user creation:

- `displayName`

- urn:ietf:params:scim:schemas:extension:Microsoft:Entra:2.0:User:mailNickname
> [!NOTE]
> The `urn:ietf:params:scim:schemas:extension:Microsoft:Entra:2.0:User:mailNickname` attribute is optional when you create a user. If you omit it, set it to `null`, or provide an empty value, Microsoft Entra ID derives `mailNickname` from `userName`. It uses the characters before the first `@`. If `userName` doesn't contain `@`, it uses the complete value. For example, `abc123@contoso.com` produces a `mailNickname` value of `abc123`.

#### Example 1 – Create a new user

Expand All @@ -750,8 +751,7 @@ Content-Type: application/scim+json
```json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:Microsoft:Entra:2.0:User"
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"active": true,
"displayName": "Example User",
Expand All @@ -760,9 +760,6 @@ Content-Type: application/scim+json
"name": {
"familyName": "Example familyName",
"givenName": "Example givenName"
},
"urn:ietf:params:scim:schemas:extension:Microsoft:Entra:2.0:User": {
"mailNickname": "abc123"
}
}
```
Expand All @@ -771,6 +768,8 @@ Content-Type: application/scim+json

Returns the SCIM representation of the user created.

In this example, Microsoft Entra ID derives the `mailNickname` value `abc123` from `userName`.

## Update a user

The /users endpoint allows a PATCH request to be made for updating an existing user profile.
Expand All @@ -794,7 +793,7 @@ Upon success, the API returns HTTP Status 204.

- For PATCH operations, while updating complex multi-valued attributes like addresses, the path property only supports “[type eq \" work\"]" filter.

- Mandatory attribute `mailNickname` can't be removed using PATCH operation.
- After a user is created, the `mailNickname` attribute can't be removed by using a PATCH operation.

#### Example 1 – Update an attribute value

Expand Down