ExScim.Groups.Group (ex_scim v0.2.2)

Group struct representing a SCIM Group resource.

Provides the core data structure for group information following SCIM 2.0 Group schema (RFC 7643 Section 4.2).

Required Fields

:display_name - Human-readable name for the group

Examples

iex> group = ExScim.Groups.Group.new("Engineering")
iex> group.display_name
"Engineering"

iex> group = ExScim.Groups.Group.new("Admins", active: true, members: [])
iex> {group.display_name, group.active}
{"Admins", true}

Summary

Types

t()

Functions

new(display_name, opts \\ [])

Creates a new Group struct with the given display name and optional fields.

Types

t()

@type t() :: %ExScim.Groups.Group{
  active: boolean() | nil,
  display_name: String.t(),
  external_id: String.t() | nil,
  id: String.t() | nil,
  members: [map()] | nil,
  meta_created: DateTime.t() | nil,
  meta_last_modified: DateTime.t() | nil
}

Functions

new(display_name, opts \\ [])

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

Creates a new Group struct with the given display name and optional fields.

Parameters

display_name - Required display name for the group
opts - Keyword list of optional group attributes

Examples

iex> group = ExScim.Groups.Group.new("Engineering")
iex> group.display_name
"Engineering"

iex> group = ExScim.Groups.Group.new("Admins", active: true)
iex> {group.display_name, group.active}
{"Admins", true}