Skip to content

Users API

The Users API provides functionalities for managing users in Umami. It allows you to create, retrieve, update, and delete users, as well as manage their associated websites and teams.

Getting Started

To access the Users API, you need an instance of the Umami class. You can then call the users() extension function to get an instance of the Users class:

val umami = Umami(website = "your_website_id")
val usersApi = umami.users()

Methods

create(username: String, password: String, role: String, id: String? = null): User

Creates a new user.

  • username: The user's username.
  • password: The user's password.
  • role: The user's role.
  • id: The user's ID (optional).

Example:

val user = umami.users().create(
    username = "new_user",
    password = "secure_password",
    role = "admin"
)

get(userId: String): User

Gets a user by ID.

  • userId: The unique identifier of the user.

Example:

val user = umami.users().get(userId = "user-id-123")

update(userId: String, username: String? = null, password: String? = null, role: String? = null): User

Updates a user.

  • userId: The unique identifier of the user.
  • username: The new username.
  • password: The new password.
  • role: The new role.

Example:

val updatedUser = umami.users().update(
    userId = "user-id-123",
    username = "updated_username",
    role = "user"
)

delete(userId: String)

Deletes a user.

  • userId: The unique identifier of the user.

Example:

umami.users().delete(userId = "user-id-123")

getWebsites(userId: String, includeTeams: Boolean = false, search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<Website>

Gets all websites that belong to a user.

  • userId: The unique identifier of the user.
  • includeTeams: Set to true if you want to include websites where you are the team owner.
  • search: Search text.
  • page: The page number to retrieve.
  • pageSize: The number of items to return per page.

Example:

val response = umami.users().getWebsites(
    userId = "user-id-123",
    page = 1,
    pageSize = 10
)

response.data.forEach { website ->
    println("Website: ${website.name}")
}

getTeams(userId: String, page: Int? = null, pageSize: Int? = null): SearchResponse<Team>

Gets all teams that belong to a user.

  • userId: The unique identifier of the user.
  • page: The page number to retrieve.
  • pageSize: The number of items to return per page.

Example:

val response = umami.users().getTeams(
    userId = "user-id-123",
    page = 1,
    pageSize = 10
)

response.data.forEach { team ->
    println("Team: ${team.name}")
}