imported>Psychpsyo Created stub |
update legacy information about user IDs |
||
| Line 1: | Line 1: | ||
< | 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 <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 are two forms of user IDs. | |||
=== Regular user ID === | |||
Most Resonite user IDs will be a [https://en.wikipedia.org/wiki/Snowflake_ID Snowflake ID], following a format of <code>U-<snowflake></code>. | |||
For instance, a regular user ID might look like <code>U-fX3pKe7AYYQ</code>. | |||
=== Migrated user ID === | |||
In the case of a [[Migrations | migrated account]], the user ID string can appear different. | |||
In most cases for those account, it will follow a format of <code>U-<username></code>. | |||
For instance, a migrated user ID might look like <code>U-Frooxius</code>. | |||
'''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 [[User Username (ProtoFlux) | UserUsername]] [[ProtoFlux]] node. | |||
As the user ID is immutable, it can be recommended to use it for [[Cloud Variables | cloud variables]] and components such as [[ValueUserOverride (Component) | ValueUserOverride]]. | |||
=== Finding a user ID === | |||
Finding user IDs can be simple and done in multiple ways: | |||
* Login on the [https://account.resonite.com Resonite account website] will display your own user ID | |||
* Using the [[User From Username (ProtoFlux) | UserFromUsername]] ProtoFlux node in combination with a [[User User ID (ProtoFlux) | UserUserID]] node (this will only work in sessions where the user is present) | |||
* Using a [[User Inspector | 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 (<code>resrec:///U-marsmaantje/R-c671fca0-7b46-413f-a116-d57b8fbdbeba</code>) | |||
Revision as of 00:57, 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 currently are two forms of user IDs.
Regular user ID
Most Resonite user IDs will be a Snowflake ID, following a format of 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 a format of U-<username>.
For instance, a migrated user ID might look like U-Frooxius.
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:
- Login on 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)