WeaviateEx.RBAC.GroupAssignment (WeaviateEx v0.7.4)

Group assignment with type information.

Represents a group assigned to a role, including the group type which indicates the source of the group (currently only OIDC groups are supported).

Group Types

:oidc - Group from OpenID Connect identity provider

Examples

{:ok, assignments} = RBAC.get_group_assignments(client, "viewer")
for assignment <- assignments do
  IO.puts("#{assignment.group_id} (type: #{assignment.group_type})")
end

Summary

Types

group_type()

t()

Functions

from_api(group_id)

Parse group assignment from API response.

group_type_to_string(atom)

Convert group type atom to API string.

new(group_id, group_type)

Creates a new GroupAssignment struct.

parse_group_type(arg1)

Parse group type string to atom.

to_api(assignment)

Convert group assignment to API format.

Types

group_type()

@type group_type() :: :oidc

t()

@type t() :: %WeaviateEx.RBAC.GroupAssignment{
  group_id: String.t(),
  group_type: group_type()
}

Functions

from_api(group_id)

@spec from_api(map()) :: t()

Parse group assignment from API response.

Examples

assignment = GroupAssignment.from_api(%{"groupId" => "eng", "groupType" => "oidc"})
# => %GroupAssignment{group_id: "eng", group_type: :oidc}

group_type_to_string(atom)

@spec group_type_to_string(group_type()) :: String.t()

Convert group type atom to API string.

new(group_id, group_type)

@spec new(String.t(), group_type()) :: t()

Creates a new GroupAssignment struct.

Examples

assignment = GroupAssignment.new("engineering", :oidc)

parse_group_type(arg1)

@spec parse_group_type(String.t()) :: group_type()

Parse group type string to atom.

to_api(assignment)

@spec to_api(t()) :: map()

Convert group assignment to API format.