API reference
API reference
Select your platform
No SDKs available
No versions available

UserCapability

Updated: Jul 24, 2025

UserCapability

interface UserCapability
This object represents a permission or capability for the logged in user, which can be retrieved by horizon.platform.users.Users.getLoggedInUser. It’s a type of array and there is a unique name for every user capability.

Properties

NameSummary
description
abstract val description: String?
The human readable description of the capability describing what possessing it entails for a given horizon.platform.users.models.User.
isEnabled
abstract val isEnabled: Boolean
Whether the capability is currently enabled for the user. When false, this field will gate the horizon.platform.users.models.User from the specified services.
json
open val json: String
name
abstract val name: String
The unique identifier for the capability. An example capability could be "earn_achievements".
reasonCode
abstract val reasonCode: String?
This field specifies the reason the capability was enabled or disabled for the given horizon.platform.users.models.User. List of Reason Codes: - REASON_UNKOWN - SOCIAL_DISTANCING - VERBAL_ABUSE - TEXT_ABUSE - PARENTAL_CONTROL
Did you find this page helpful?
Thumbs up icon
Thumbs down icon