m improve wording |
add more information and rewording |
||
| Line 5: | Line 5: | ||
All user IDs will start with the string <code>U-</code> (the letter "U" signifying "user" while other letters like "G" or "R" will mean "group" and "record" for the most common). | All user IDs will start with the string <code>U-</code> (the letter "U" signifying "user" while other letters like "G" or "R" will mean "group" and "record" for the most common). | ||
There currently | There are currently two user IDs formats. | ||
=== Regular user ID === | === Regular user ID === | ||
| Line 20: | Line 20: | ||
For instance, a migrated user ID might look like <code>U-Frooxius</code>. | For instance, a migrated user ID might look like <code>U-Frooxius</code>. | ||
Some system accounts such as the [[Resonite Bot | Resonite bot]] also have a user ID following that format. | |||
'''Never ever assume a user ID will match a username.''' | '''Never ever assume a user ID will match a username.''' | ||
Revision as of 01:16, 15 January 2024
A user's User ID (also written userid) is an immutable ID linked to their user account.
Format
All user IDs will start with the string U- (the letter "U" signifying "user" while other letters like "G" or "R" will mean "group" and "record" for the most common).
There are currently two user IDs formats.
Regular user ID
Most Resonite user IDs will be a Snowflake ID, following the format U-<snowflake>.
For instance, a regular user ID might look like U-fX3pKe7AYYQ.
Migrated user ID
In the case of a migrated account, the user ID string can appear different.
In most cases for those account, it will follow the format U-<username>.
For instance, a migrated user ID might look like U-Frooxius.
Some system accounts such as the Resonite bot also have a user ID following that format.
Never ever assume a user ID will match a username.
Use
It is generally recommended to not display this ID in user-facing scenarios (facets, worlds, ect) and instead display the username of the user by using the UserUsername ProtoFlux node.
As the user ID is immutable, it can be recommended to use it for cloud variables and components such as ValueUserOverride.
Finding a user ID
Finding user IDs can be simple and done in multiple ways:
- Logging onto the Resonite account website will display your own user ID
- Using the UserFromUsername ProtoFlux node in combination with a UserUserID node (this will only work in sessions where the user is present)
- Using a user inspector (this will also only work for users present in the session)
- Use the API to search and find users
- Use a tool such as marsmaantje's user searcher (
resrec:///U-marsmaantje/R-c671fca0-7b46-413f-a116-d57b8fbdbeba)