rename "migrated user id" to "username user id" as other cases might apply |
Marked this version for translation |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<languages /> | |||
<translate><!--T:1--> A user's User ID (also written userid) is an immutable ID linked to their user account.</translate> | |||
== <translate><!--T:2--> Format</translate> == | |||
<translate><!--T:3--> 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).</translate> | |||
<translate><!--T:4--> There are currently two user IDs formats.</translate> | |||
=== <translate><!--T:5--> Regular user ID</translate> === | |||
<translate><!--T:6--> Most Resonite user IDs will be a [[Wikipedia:Snowflake_ID | Snowflake ID]], following the format <code>U-<snowflake></code>.</translate> | |||
<translate><!--T:7--> For instance, a regular user ID might look like <code>U-fX3pKe7AYYQ</code>.</translate> | |||
=== <translate><!--T:8--> Username user ID</translate> === | |||
In such | <translate><!--T:9--> In the case of [[Migrations | migrated accounts]] or system accounts such as the [[Resonite Bot | Resonite bot]], the user ID string can appear in a different format.</translate> | ||
<translate><!--T:10--> In such cases, it will follow the format <code>U-<username></code>.</translate> | |||
<translate><!--T:11--> For instance, a username user ID might look like <code>U-Frooxius</code>.</translate> | |||
<translate><!--T:12--> '''Never ever assume a user ID will match a username.'''</translate> | |||
== <translate><!--T:13--> Use</translate> == | |||
<translate><!--T:14--> 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.</translate> | |||
<translate><!--T:15--> 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]].</translate> | |||
Finding user | === <translate><!--T:16--> Finding a user ID</translate> === | ||
* Logging onto the [https://account.resonite.com Resonite account website] will display your own user ID | <translate><!--T:17--> Finding user IDs can be simple and done in multiple ways:</translate> | ||
* 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) | * <translate><!--T:18--> Logging onto the [https://account.resonite.com Resonite account website] will display your own user ID</translate> | ||
* Use the [[API]] to search and find users | * <translate><!--T:19--> 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)</translate> | ||
* Use a tool such as marsmaantje's user searcher (<code>resrec:///U-marsmaantje/R-c671fca0-7b46-413f-a116-d57b8fbdbeba</code>) | * <translate><!--T:20--> Using a [[User Inspector | user inspector]] (this will also only work for users present in the session)</translate> | ||
* <translate><!--T:21--> Use the [[API]] to search and find users</translate> | |||
* <translate><!--T:22--> Use a tool such as marsmaantje's user searcher (<code>resrec:///U-marsmaantje/R-c671fca0-7b46-413f-a116-d57b8fbdbeba</code>)</translate> | |||
Latest revision as of 10:39, 22 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.
Username user ID
In the case of migrated accounts or system accounts such as the Resonite bot, the user ID string can appear in a different format.
In such cases, it will follow the format U-<username>.
For instance, a username 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:
- 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)