WeaviateEx.Groups.Group (WeaviateEx v0.7.4)

View Source

OIDC Group representation.

Groups are used in Weaviate when OIDC authentication is enabled. Users authenticated via OIDC can belong to groups, and roles can be assigned to these groups.

Examples

%Group{
  name: "engineering",
  roles: ["developer", "viewer"]
}

Summary

Types

t()

Functions

from_api(api_data)

Decode a group from API response.

Types

t()

@type t() :: %WeaviateEx.Groups.Group{name: String.t(), roles: [String.t()]}

Functions

from_api(api_data)

@spec from_api(map()) :: {:ok, t()}

Decode a group from API response.

Examples

{:ok, group} = Group.from_api(%{
  "name" => "engineering",
  "roles" => ["developer"]
})