QlikElixir.REST.Roles (qlik_elixir v0.3.5)

View Source

REST API client for Qlik Cloud Roles.

Provides functions to query available roles for user assignment. Roles in Qlik Cloud are predefined and cannot be created or modified.

Examples

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

# Get role details
{:ok, role} = Roles.get("role-123", config: config)

Summary

Functions

get(role_id, opts \\ [])

Gets a role by ID.

list(opts \\ [])

Lists all available roles.

Functions

get(role_id, opts \\ [])

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

Gets a role by ID.

list(opts \\ [])

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

Lists all available roles.

Options

  • :config - Required. The configuration struct.
  • :limit - Maximum number of results per page.
  • :next - Cursor for pagination.
  • :name - Filter by role name.
  • :type - Filter by role type (e.g., "default").