The FusionAuth.Groups module provides access methods to the FusionAuth Groups API.

All methods require a Tesla Client struct created with FusionAuth.client(base_url, api_key).

Group Fields

• id :: String.t()

  The unique Id of this Group. If not specified a secure random UUID will be generated.

• tenantId :: String.t()

  The tenant of which this Group belongs to.

• name :: String.t()

  The unique name of the Group.

• data :: map()

  An object that can hold any information about the Group that should be persisted.

• roles :: map()

  The roles assigned to this Group. The map key is the Application Id, the value is an array of Application Roles.

Member Fields

• id :: String.t()

  The unique Id of this Group Member. If not specified a secure random UUID will be generated.

• userId :: String.t()

  The user of which this Group Member belongs to.

• data :: map()

  An object that can hold any information about the Group Member that should be persisted.

• insertInstant :: integer()

  Value represents the instant them member was created in epoch time

Examples

  iex> client = FusionAuth.client(...)
  iex> FusionAuth.Groups.get_group(client, "a4c99f4f-24d5-49bf-921f-ff80fc76b3ef")
  {
    :ok,
    %{
      "group" => %{
        "data" => %{"description" => "My First Group"},
        "id" => "a4c99f4f-24d5-49bf-921f-ff80fc76b3ef",
        "name" => "Group",
        "roles" => %{
          "861f5558-34a8-43e4-ab50-317bdcd47671" => [
            %{
              "description" => "admin",
              "id" => "3ebbc43c-7add-42cd-87b4-c6eca0438c6c",
              "isDefault" => true,
              "isSuperRole" => true,
              "name" => "admin"
            }
          ]
        },
        "tenantId" => "edad5b36-25a2-0631-3694-64ba3d39bce9"
      }
    },
    %Tesla.Env{...}
  }

  iex> FusionAuth.Groups.add_member(client, "a4c99f4f-24d5-49bf-921f-ff80fc76b3ef", "84846873-89d2-44f8-91e9-dac80f420cb2")
  {
    :ok,
    %{
      "members" => %{
        "a4c99f4f-24d5-49bf-921f-ff80fc76b3ef" => [
          %{
            "id" => "67c66607-d3ed-4073-adb2-53de8d10ac4e",
            "insertInstant" => 1591306181126,
            "userId" => "84846873-89d2-44f8-91e9-dac80f420cb2"
          }
        ]
      }
    },
    %Tesla.Env{...}
  }