QlikElixir.REST.Users (qlik_elixir v0.3.5)

REST API client for Qlik Cloud Users.

Provides functions to manage users including listing, creating, updating, and deleting users, as well as filtering and inviting users.

Examples

# List all users
{:ok, %{"data" => users}} = Users.list(config: config)

# Get current user
{:ok, user} = Users.me(config: config)

# Get user by ID
{:ok, user} = Users.get("user-123", config: config)

# Create a new user
{:ok, user} = Users.create(%{name: "Alice", email: "alice@example.com"}, config: config)

# Invite users
{:ok, result} = Users.invite(["user1@example.com", "user2@example.com"], config: config)

Summary

Functions

count(opts \\ [])

Gets the count of users.

create(params, opts \\ [])

Creates a new user.

delete(user_id, opts \\ [])

Deletes a user.

filter(filter_query, opts \\ [])

Filters users using SCIM filter syntax.

get(user_id, opts \\ [])

Gets a user by ID.

invite(emails, opts \\ [])

Invites users by email.

list(opts \\ [])

Lists all users.

me(opts \\ [])

Gets the current authenticated user.

update(user_id, params, opts \\ [])

Updates a user.

Functions

count(opts \\ [])

@spec count(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets the count of users.

Options

:filter - SCIM filter string to count matching users.

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Creates a new user.

Parameters

params - Map with user details:
- :name - Required. User display name.
- :email - Required. User email address.
- :subject - Identity provider subject (optional).

delete(user_id, opts \\ [])

@spec delete(
  String.t(),
  keyword()
) :: :ok | {:error, QlikElixir.Error.t()}

Deletes a user.

filter(filter_query, opts \\ [])

@spec filter(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Filters users using SCIM filter syntax.

Parameters

filter_query - SCIM filter string (e.g., email eq "test@example.com").

get(user_id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets a user by ID.

invite(emails, opts \\ [])

@spec invite(
  [String.t()],
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Invites users by email.

Parameters

emails - List of email addresses to invite.

list(opts \\ [])

@spec list(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Lists all users.

Options

:config - Required. The configuration struct.
:limit - Maximum number of results per page.
:next - Cursor for pagination.
:filter - SCIM filter string.
:sort - Sort field and direction.

me(opts \\ [])

@spec me(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets the current authenticated user.

update(user_id, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Updates a user.

Parameters

user_id - The user ID.
params - Map with fields to update.