UserService

Inherits from: Instance → Object

A service that handles queries regarding users on the Roblox platform.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service

Methods

Name	Type / Returns	Description
UserService:GetUserInfosByUserIdsAsync	Array	Returns an array of user information including user name and display name.
UserService:GetUserFromGlobalUserIdAsync	User	Returns a `User` for the given global user ID within the current experience.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

UserService:GetUserInfosByUserIdsAsync

This function lets you request information about users outside of the current DataModel in bulk. The input and output values are both arrays.

The order of the user info objects in the return value's array may not match the order of the UserIds sent in the input parameter's array. Use the Id field of the user info object to identify your input array with the output array.
It's possible to receive fewer user info objects than requested if one or more of the UserIds in the request array are invalid, such as negative numbers or user IDs that don't have accounts associated with them. It's possible to receive a response with zero results if all UserIds are invalid.
If a Roblox user does not have a DisplayName associated with their account, this function will instead return the same string as the user's username in their info object's DisplayName field. While a user's UserId will never change, they may change their username or display name, so the same input UserIds may return a different string for these fields from one day to another.
Since GetUserInfosByUserIdsAsync() makes an external web request, it will yield and may fail if the backend service is experiencing interruptions. Ensure you can handle downtime appropriately by wrapping this method with a LuaGlobals.pcall().
Results are limited to 250 per minute, so if you receive an HTTP 429 error, try again later, ideally after reducing the number of UserIds in your input array, reducing the number of method calls, or both.

The signature of a singular user info object is:

Key	Type	Description
`Id`	number	The `Class.Player.UserId\|UserId` associated with the user.
`Username`	string	The username associated with the user.
`DisplayName`	string	The `Class.Player.DisplayName\|DisplayName` associated with the user.
`HasVerifiedBadge`	boolean	The `Class.Player.HasVerifiedBadge\|HasVerifiedBadge` value associated with the user.

Parameters

Name	Type	Default	Description
userIds	Array		An array of `UserIds` requested.

Returns

Type	Description
Array	An array of dictionary objects that contain user information.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Basic"]

Code samples: View on Creator Hub (userservice-getuserinfosbyuseridsasync-example).

UserService:GetUserFromGlobalUserIdAsync

Resolves a global user ID to a User for the current experience domain. Use this when you have a legacy global user ID (for example, one previously saved in a data store) and need the corresponding User value.

This is a server-only yielding call.

Parameters

Name	Type	Default	Description
userId	int64		The global user ID to resolve.

Returns

Type	Description
User	User: The `User` representing the resolved domain-scoped identity.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Basic"]

Code samples: View on Creator Hub (UserService-GetUserFromGlobalUserIdAsync).

Properties

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.