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

Copy Markdown View Source

Operations for the DirectorySync API.

Summary

Functions

delete_directory(client, id, opts \\ [])

Delete a Directory

get_directory(client, id, opts \\ [])

Get a Directory

get_group(client, id, opts \\ [])

Get a Directory Group

get_user(client, id, opts \\ [])

Get a Directory User

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

List Directories

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

List Directory Groups

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

List Directory Users

Functions

delete_directory(client, id, opts \\ [])

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

Delete a Directory

Permanently deletes an existing directory. It cannot be undone.

Parameters

get_directory(client, id, opts \\ [])

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

Get a Directory

Get the details of an existing directory.

Parameters

get_group(client, id, opts \\ [])

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

Get a Directory Group

Get the details of an existing Directory Group.

Parameters

get_user(client, id, opts \\ [])

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

Get a Directory User

Get the details of an existing Directory User.

Parameters

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

@spec list_directories(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.Directory.t())} | {:error, WorkOS.Error.error()}

List Directories

Get a list of all of your existing directories matching the criteria specified.

Parameters

  • params — query parameters: :before, :after_, :limit, :order, :organization_id, :search, :domain (deprecated)
  • opts — per-request options (see WorkOS.Client.request/5)

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

@spec list_groups(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.DirectoryGroup.t())}
  | {:error, WorkOS.Error.error()}

List Directory Groups

Get a list of all of existing directory groups matching the criteria specified.

Parameters

  • params — query parameters: :before, :after_, :limit, :order, :directory, :user
  • opts — per-request options (see WorkOS.Client.request/5)

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

@spec list_users(WorkOS.Client.t(), map(), keyword()) ::
  {:ok, WorkOS.Page.t(WorkOS.DirectoryUserWithGroups.t())}
  | {:error, WorkOS.Error.error()}

List Directory Users

Get a list of all of existing Directory Users matching the criteria specified.

Parameters

  • params — query parameters: :before, :after_, :limit, :order, :directory, :group, :idp_id, :email
  • opts — per-request options (see WorkOS.Client.request/5)