Skip to content

Commit e125cee

Browse files
Update the username normalization doc to clearly specify that case of the normalized value would match the letter casing from the IdP. Also updated the examples to reflect the same. (#57430)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
1 parent 4176832 commit e125cee

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

content/admin/managing-iam/iam-configuration-reference/username-considerations-for-external-authentication.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ When you configure CAS, LDAP, or SAML authentication (without SCIM), {% data var
114114

115115
1. {% data variables.product.github %} will normalize any non-alphanumeric character in your account's username into a dash. For example, a username of `mona.the.octocat` will be normalized to `mona-the-octocat`. Note that normalized usernames also can't start or end with a dash. They also can't contain two consecutive dashes.
116116

117+
1. The letter casing in the value provided by the IdP is preserved in the normalized username.
118+
117119
1. Usernames created from email addresses are created from the normalized characters that precede the `@` character.
118120

119121
1. Usernames created from domain accounts are created from the normalized characters after the `\\` separator.
@@ -124,12 +126,12 @@ When you configure CAS, LDAP, or SAML authentication (without SCIM), {% data var
124126

125127
| Identifier on provider | Normalized username on {% data variables.product.prodname_dotcom_the_website %} | Result |
126128
| :- | :- | :- |
127-
| The.Octocat | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is created successfully. |
128-
| !The.Octocat | `-the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it starts with a dash. |
129-
| The!!Octocat | `the--octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it contains two consecutive dashes. |
130-
| The!Octocat | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
131-
| `The.Octocat@example.com` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
132-
| `internal\\The.Octocat` | `the-octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
129+
| The.Octocat | `The-Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is created successfully. |
130+
| !The.Octocat | `-The-Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it starts with a dash. |
131+
| The!!Octocat | `The--Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it contains two consecutive dashes. |
132+
| The!Octocat | `The-Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
133+
| `The.Octocat@example.com` | `The-Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
134+
| `internal\\The.Octocat` | `The-Octocat{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created. Although the normalized username is valid, it already exists. |
133135
| `mona.lisa.the.octocat.from.github.united.states@example.com` | `mona-lisa-the-octocat-from-github-united-states{% ifversion ghec %}_SHORT-CODE{% endif %}` | This username is not created, because it exceeds the 39-character limit. |
134136

135137
{% ifversion ghes %}

0 commit comments

Comments
 (0)