@spec add_org_member(
  org_name :: Aura.Common.org_name(),
  username :: Aura.Common.username(),
  role :: Aura.Model.HexOrgMember.role(),
  opts :: org_opts()
) :: {:ok, Aura.Model.HexOrgMember.t()} | {:error, any()}

Adds a user to an org with a given role

Parameters

API Details

@spec change_member_role(
  org_name :: Aura.Common.org_name(),
  username :: Aura.Common.username(),
  new_role :: Aura.Model.HexOrgMember.role(),
  opts :: org_opts()
) :: {:ok, Aura.Model.HexOrgMember.t()} | {:error, any()}

Changes a user's role to new_role

Parameters

API Details

@spec get_org(org_name :: Aura.Common.org_name(), opts :: org_opts()) ::
  {:ok, Aura.Model.HexOrg.t()} | {:error, any()}

Grabs an organization, given an org_name

Parameters

API Details

Examples

iex> alias Aura.Orgs
iex> opts = [repo_url: "http://localhost:4000/api"]
iex> {:ok, org} = Orgs.get_org("test_org", opts)
iex> org.name
"test_org"

@spec get_org_member(
  org_name :: Aura.Common.org_name(),
  username :: Aura.Common.username(),
  opts :: org_opts()
) :: {:ok, Aura.Model.HexOrgMember.t()} | {:error, any()}

Grabs an org member, given their org_name and username

Parameters

API Details

Examples

iex> alias Aura.Orgs
iex> opts = [repo_url: "http://localhost:4000/api"]
iex> {:ok, member} = Orgs.get_org_member("test_org", "testuser", opts)
iex> member.username
"testuser"

@spec list_org_members(org_name :: Aura.Common.org_name(), opts :: org_opts()) ::
  {:ok, Aura.Model.HexOrgMember.t()} | {:error, any()}

Grabs a list of members to an organization, given an org_name

Parameters

API Details

Examples

iex> alias Aura.Orgs
iex> opts = [repo_url: "http://localhost:4000/api"]
iex> {:ok, members} = Orgs.list_org_members("test_org", opts)
iex> Enum.empty?(members)
false

@spec list_orgs(opts :: org_opts()) ::
  {:ok, [Aura.Model.HexOrg.t()]} | {:error, any()}

Lists all the organizations the requester can see

Parameters

API Details

Examples

iex> alias Aura.Orgs
iex> opts = [repo_url: "http://localhost:4000/api"]
iex> {:ok, orgs} = Orgs.list_orgs(opts)
iex> Enum.empty?(orgs)
false

@spec remove_org_member(
  org_name :: Aura.Common.org_name(),
  username :: Aura.Common.username(),
  opts :: org_opts()
) :: :ok | {:error, any()}

Removes a user from an org

Parameters

API Details

@spec stream_audit_logs(
  org_name :: Aura.Common.org_name(),
  opts :: Aura.Common.audit_opts()
) ::
  Enumerable.t()

Streams audit logs, scoped to an organization

Note that the page size is fixed by the API to be 100 per page.

Parameters

API Details

Examples

iex> alias Aura.Orgs
iex> opts = [repo_url: "http://localhost:4000/api"]
iex> [first, _second] = Orgs.stream_audit_logs("test_org", opts) |> Enum.take(2)
iex> String.starts_with?(first.user_agent, "aura")
true