WorkOS.Groups (WorkOS SDK for Elixir v3.0.1)

@spec create_group_organization_membership(
  WorkOS.Client.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) :: {:ok, WorkOS.Group.t()} | {:error, WorkOS.Error.error()}

Add a member to a Group

Add an organization membership to a group.

Parameters

organization_id — Unique identifier of the Organization.
group_id — Unique identifier of the Group.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)

create_organization_group(client, organization_id, params \\ %{}, opts \\ [])

@spec create_organization_group(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.Group.t()} | {:error, WorkOS.Error.error()}

Create a group

Create a new group within an organization.

Parameters

organization_id — The ID of the organization.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)

delete_group_organization_membership(client, organization_id, group_id, om_id, opts \\ [])

@spec delete_group_organization_membership(
  WorkOS.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, term()} | {:error, WorkOS.Error.error()}

Remove a member from a Group

Remove an organization membership from a group.

Parameters

organization_id — Unique identifier of the Organization.
group_id — Unique identifier of the Group.
om_id — Unique identifier of the Organization Membership.
opts — per-request options (see WorkOS.Client.request/5)

delete_organization_group(client, organization_id, group_id, opts \\ [])

@spec delete_organization_group(WorkOS.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, term()} | {:error, WorkOS.Error.error()}

Delete a group

Delete a group from an organization.

Parameters

organization_id — The ID of the organization.
group_id — The ID of the group.
opts — per-request options (see WorkOS.Client.request/5)

get_organization_group(client, organization_id, group_id, opts \\ [])

@spec get_organization_group(WorkOS.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, WorkOS.Group.t()} | {:error, WorkOS.Error.error()}

Get a group

Retrieve a group by its ID within an organization.

Parameters

organization_id — The ID of the organization.
group_id — The ID of the group.
opts — per-request options (see WorkOS.Client.request/5)

list_group_organization_memberships(client, organization_id, group_id, params \\ %{}, opts \\ [])

@spec list_group_organization_memberships(
  WorkOS.Client.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, WorkOS.Page.t(WorkOS.UserOrganizationMembershipBaseListData.t())}
  | {:error, WorkOS.Error.error()}

List Group members

Get a list of organization memberships in a group.

Parameters

organization_id — Unique identifier of the Organization.
group_id — Unique identifier of the Group.
params — query parameters: :before, :after_, :limit, :order
opts — per-request options (see WorkOS.Client.request/5)

list_organization_groups(client, organization_id, params \\ %{}, opts \\ [])

@spec list_organization_groups(WorkOS.Client.t(), String.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.Group.t())} | {:error, WorkOS.Error.error()}

List groups

Get a paginated list of groups within an organization.

Parameters

organization_id — The ID of the organization.
params — query parameters: :before, :after_, :limit, :order
opts — per-request options (see WorkOS.Client.request/5)

update_organization_group(client, organization_id, group_id, params \\ %{}, opts \\ [])

@spec update_organization_group(
  WorkOS.Client.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, WorkOS.Group.t()} | {:error, WorkOS.Error.error()}

Update a group

Update an existing group. Only the fields provided in the request body will be updated.

Parameters

organization_id — The ID of the organization.
group_id — The ID of the group.
params — request body map
opts — per-request options (see WorkOS.Client.request/5)