Expand description
The official SDK for interacting with the WorkOS API.
Modules§
- admin_
portal - A module for interacting with the WorkOS Admin Portal.
- directory_
sync - A module for interacting with the WorkOS Directory Sync API.
- mfa
- A module for interacting with the WorkOS Multi-factor Authentication (MFA) API.
- organizations
- A module for interacting with organizations within WorkOS.
- passwordless
- A module for working with passwordless authentication, namely Magic Link.
- sso
- A module for interacting with the WorkOS Single Sign-On (SSO) API.
- webhooks
- A module for receiving webhooks from WorkOS.
Structs§
- ApiKey
- An API key to authenticate with the WorkOS API.
- List
Metadata - The metadata for a
PaginatedList. - Paginated
List - A paginated list of records.
- Pagination
Params - The parameters used to control pagination for a given paginated endpoint.
- RawAttributes
- The raw attributes returned from the Identity or Directory Provider.
- Timestamp
- A UTC timestamp.
- Timestamps
- The timestamps for an object.
- WorkOs
- The WorkOS client.
- Work
OsBuilder - A builder for a WorkOS client.
Enums§
- Known
OrUnknown KnownOrUnknownis a type that respresents either a known value (Known) or an unknown value (Unknown).- Pagination
Order - The order in which records should be returned when paginating.
- Work
OsError - A WorkOS SDK error.
Type Aliases§
- Work
OsResult - A WorkOS SDK result.