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

UserOptions

Updated: Oct 30, 2025

UserOptions

interface UserOptions
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.

Types

NameSummary
interface Builder
Companion
object Companion

Properties

NameSummary
maxUsers
abstract val maxUsers: Long
This field specifies the maximum number of horizon.platform.users.models.User that should be returned in the response.
serviceProviders
abstract val serviceProviders: List<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
abstract val timeWindow: TimeWindow
This field specifies the time window in seconds for which the linked accounts should be retrieved.

Functions

NameSummary
addServiceProvider
abstract fun addServiceProvider(value: ServiceProvider)
clearServiceProviders
abstract fun clearServiceProviders()

Companion

object Companion

Functions

NameSummary
builder
fun builder(): UserOptions.Builder