QlikElixir.REST.Groups (qlik_elixir v0.3.5)

View Source

REST API client for Qlik Cloud Groups.

Provides functions to manage user groups for access control.

Examples

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

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

# Create a group
{:ok, group} = Groups.create(%{name: "Developers"}, config: config)

# Get group settings
{:ok, settings} = Groups.list_settings(config: config)

Summary

Functions

create(params, opts \\ [])

Creates a new group.

delete(group_id, opts \\ [])

Deletes a group.

get(group_id, opts \\ [])

Gets a group by ID.

list(opts \\ [])

Lists all groups.

list_settings(opts \\ [])

Gets group settings for the tenant.

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

Updates a group.

update_settings(params, opts \\ [])

Updates group settings for the tenant.

Functions

create(params, opts \\ [])

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

Creates a new group.

Parameters

  • params - Map with group details:
    • :name - Required. Group name.

delete(group_id, opts \\ [])

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

Deletes a group.

get(group_id, opts \\ [])

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

Gets a group by ID.

list(opts \\ [])

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

Lists all groups.

Options

  • :config - Required. The configuration struct.
  • :limit - Maximum number of results per page.
  • :next - Cursor for pagination.
  • :name - Filter by group name.

list_settings(opts \\ [])

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

Gets group settings for the tenant.

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

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

Updates a group.

Parameters

  • group_id - The group ID.
  • params - Map with fields to update.

update_settings(params, opts \\ [])

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

Updates group settings for the tenant.

Parameters

  • params - Map with settings to update:
    • :autoCreateGroups - Whether to auto-create groups from IdP.
    • :syncIdpGroups - Whether to sync groups from IdP.