View Source WorkOS.DirectorySync (WorkOS SDK for Elixir v1.1.0)
Manage Directory Sync in WorkOS.
Summary
Functions
Deletes a directory.
Gets a directory given an ID.
Gets a directory group given an ID.
Gets a directory user given an ID.
Lists all directories.
Lists all directory groups.
Lists all directory users.
Functions
@spec delete_directory(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(nil)
Deletes a directory.
@spec get_directory(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(WorkOS.DirectorySync.Directory.t())
Gets a directory given an ID.
Gets a directory group given an ID.
Gets a directory user given an ID.
@spec list_directories(map()) :: WorkOS.Client.response(WorkOS.List.t(WorkOS.DirectorySync.Directory.t()))
@spec list_directories(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.List.t(WorkOS.DirectorySync.Directory.t()))
Lists all directories.
Parameter options:
:domain- The domain of a Directory.:organization_id- Filter Directories by their associated organization.:search- Searchable text to match against Directory names.:limit- Maximum number of records to return. Accepts values between 1 and 100. Default is 10.:before- An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.:after- Pagination cursor to receive records after a provided event ID.:order- Order the results by the creation time. Supported values are "asc" and "desc" for showing older and newer records first respectively.
@spec list_groups(map()) :: WorkOS.Client.response( WorkOS.List.t(WorkOS.DirectorySync.Directory.Group.t()) )
@spec list_groups(WorkOS.Client.t(), map()) :: WorkOS.Client.response( WorkOS.List.t(WorkOS.DirectorySync.Directory.Group.t()) )
Lists all directory groups.
Parameter options:
:directory- Unique identifier of the WorkOS Directory.:user- Unique identifier of the WorkOS Directory User.:limit- Maximum number of records to return. Accepts values between 1 and 100. Default is 10.:before- An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.:after- Pagination cursor to receive records after a provided event ID.:order- Order the results by the creation time. Supported values are "asc" and "desc" for showing older and newer records first respectively.
@spec list_users(map()) :: WorkOS.Client.response(WorkOS.List.t(WorkOS.DirectorySync.Directory.User.t()))
@spec list_users(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.List.t(WorkOS.DirectorySync.Directory.User.t()))
Lists all directory users.
Parameter options:
:directory- Unique identifier of the WorkOS Directory.:group- Unique identifier of the WorkOS Directory Group.:limit- Maximum number of records to return. Accepts values between 1 and 100. Default is 10.:before- An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.:after- Pagination cursor to receive records after a provided event ID.:order- Order the results by the creation time. Supported values are "asc" and "desc" for showing older and newer records first respectively.