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

UserOptions

Updated: Aug 26, 2025

UserOptions

data class UserOptions(var maxUsers: Long = 0, var serviceProviders: MutableList<ServiceProvider> = mutableListOf(), var timeWindow: TimeWindow = TimeWindow.Unknown)
The user_options configuration is used to specify additional settings for the horizon.platform.users.models.User. It allows you to customize the response by specifying the time window, maximum number of users, and service providers for which linked accounts should be retrieved.

Constructors

NameSummary
UserOptions
constructor(maxUsers: Long = 0, serviceProviders: MutableList<ServiceProvider> = mutableListOf(), timeWindow: TimeWindow = TimeWindow.Unknown)

Properties

NameSummary
maxUsers
var maxUsers: Long
This field specifies the maximum number of horizon.platform.users.models.User that should be returned in the response.
serviceProviders
var serviceProviders: MutableList<ServiceProvider>
It’s an array of horizon.platform.users.enums.ServiceProvider objects that specifies the service providers for which linked accounts should be retrieved.
timeWindow
var timeWindow: TimeWindow
This field specifies the time window in seconds for which the linked accounts should be retrieved.

Functions

NameSummary
addServiceProvider
fun addServiceProvider(value: ServiceProvider)
clearServiceProviders
fun clearServiceProviders()
Did you find this page helpful?
Thumbs up icon
Thumbs down icon