Skip to main content
WorkOS logo
  • Category: security & identity tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: WORKOS
  • Version: 20261101_00

Tools

Slug: WORKOS_CREATE_ORGANIZATIONCreate a WorkOS organization in the connected environment.

Input Parameters

string
required
Organization display name.
object
Optional metadata with at most 50 pairs. Keys may contain up to 40 characters and values up to 600 characters.
array
Domains to associate with the organization. Each record must include a domain and verification state.
string
Optional ASCII external identifier, up to 128 characters.
boolean
Whether profiles outside this organization may sign in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_CREATE_ORGANIZATION_MEMBERSHIPGrant an AuthKit user active membership in an organization. An existing inactive membership for the same user and organization is reactivated.

Input Parameters

string
required
WorkOS user to grant organization access.
string
One role slug to assign. Omit both role fields to use the default role; do not provide this with role_slugs.
array
Role slugs to assign when Multiple Roles is enabled. Omit both role fields to use the default role; do not provide this with role_slug.
string
required
WorkOS organization the user will join.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_CREATE_USERCreate a passwordless AuthKit user record in the connected WorkOS environment. This tool does not accept plaintext or hashed passwords.

Input Parameters

string
Full name for the new user, or null when it is not known.
string
required
Email address for the new user.
object
Optional metadata with at most 50 pairs. Keys may contain up to 40 characters and values up to 600 characters.
string
Last name for the new user, or null when it is not known.
string
First name for the new user, or null when it is not known.
string
Optional ASCII external identifier, up to 128 characters.
boolean
Whether the email has already been independently verified. Set this only when verification is backed by trusted evidence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_DELETE_ORGANIZATIONRequest permanent deletion of a WorkOS organization by ID. The request cannot be undone and should only target a confirmed organization ID; acceptance does not necessarily mean deletion is complete.

Input Parameters

string
required
Exact WorkOS organization ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_DELETE_ORGANIZATION_MEMBERSHIPPermanently remove an organization membership and its access. Prefer deactivation when access may need to be restored.

Input Parameters

string
required
Exact WorkOS organization membership ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_DELETE_USERPermanently delete an AuthKit user. This cannot be undone and may remove the user’s access.

Input Parameters

string
required
Exact WorkOS user ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_CONNECTIONGet one WorkOS connection by ID.

Input Parameters

string
required
WorkOS connection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_DIRECTORYGet one WorkOS Directory Sync directory by ID.

Input Parameters

string
required
WorkOS directory ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_DIRECTORY_GROUPGet one WorkOS Directory Sync group by its exact group ID.

Input Parameters

string
required
Exact WorkOS directory group ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_DIRECTORY_USERGet one WorkOS Directory Sync user by exact ID, including identity-provider attributes, roles, and any groups returned by WorkOS. For complete group memberships, use List Directory Groups filtered by this directory user ID.

Input Parameters

string
required
Exact WorkOS directory user ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_INVITATIONGet WorkOS AuthKit invitation status and metadata by invitation ID without exposing acceptance credentials.

Input Parameters

string
required
WorkOS invitation ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_ORGANIZATIONGet one WorkOS organization by its WorkOS ID or external ID.

Input Parameters

string
Your external organization ID. Provide exactly one identifier.
string
WorkOS organization ID. Provide exactly one identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_ORGANIZATION_MEMBERSHIPGet one WorkOS AuthKit organization membership by ID.

Input Parameters

string
required
WorkOS organization membership ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_GET_USERGet one WorkOS AuthKit user by WorkOS ID or external ID.

Input Parameters

string
WorkOS user ID. Provide exactly one identifier.
string
Your external user ID. Provide exactly one identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_CONNECTIONSList one page of WorkOS SSO and OAuth connections, optionally filtered by connection type, domain, organization, or name.

Input Parameters

integer
Maximum connections to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned connections.
string
Return connections associated with this domain.
Text to match against connection names.
string
Cursor returned by a previous call. Omit for the first page.
string ("ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitLabOAuth" | "GithubOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "GrokOAuth" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceOAuth" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth" | "XOAuth")
Exact WorkOS connection type, such as OktaSAML or GoogleOAuth.
string
Return connections associated with this WorkOS organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_DIRECTORIESList one page of WorkOS Directory Sync directories, optionally filtered by organization, directory name, or domain.

Input Parameters

integer
Maximum directories to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned directories.
string
Return directories associated with this domain.
string
Text to match against directory names.
string
Cursor returned by a previous call. Omit for the first page.
string
Return directories associated with this WorkOS organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_DIRECTORY_GROUPSList one page of WorkOS Directory Sync groups for a directory, a directory user, or both.

Input Parameters

integer
Maximum groups to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned directory groups.
string
Cursor returned by a previous call. Omit for the first page.
string
WorkOS directory whose groups to list. Provide directory_id, directory_user_id, or both.
string
WorkOS directory user whose groups to list. Provide directory_id, directory_user_id, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_DIRECTORY_USERSList one page of WorkOS Directory Sync users for a directory or group, optionally filtering a directory by exact identity-provider ID or primary email. WorkOS limits this endpoint to 4 requests per second per directory; on HTTP 429, honor Retry-After before retrying.

Input Parameters

string
Exact primary email address to match. This filter requires directory_id.
integer
Maximum directory users to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned directory users.
string
Exact identity-provider user ID to match. This filter requires directory_id.
string
Cursor returned by a previous call. Omit for the first page.
string
Directory whose users to list. Provide this or directory_group_id. Required when filtering by idp_id or email.
string
Directory group whose users to list. Provide this or directory_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_INVITATIONSList one page of WorkOS AuthKit invitations by organization or exact recipient email without exposing acceptance credentials.

Input Parameters

string
Exact recipient email address to match.
integer
Maximum invitations to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned invitations.
string
Opaque cursor returned by a previous call. Omit for the first page.
string
Return invitations associated with this WorkOS organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_ORGANIZATION_MEMBERSHIPSList one page of WorkOS AuthKit organization memberships for a specific organization or user, optionally including inactive or pending memberships.

Input Parameters

integer
Maximum memberships to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned memberships.
string
User whose memberships to list. Provide this or organization_id.
array
Membership statuses to include. WorkOS returns only active memberships when this filter is omitted.
string
Cursor returned by a previous call. Omit for the first page.
string
Organization whose memberships to list. Provide this or user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_ORGANIZATIONSList one page of WorkOS organizations, optionally filtered by domain or organization name.

Input Parameters

integer
Maximum organizations to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned organizations.
string
Text to match against organization names.
array
Return organizations matching any supplied domain.
string
Cursor returned by a previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_LIST_USERSList one page of WorkOS AuthKit users, optionally filtered by organization or exact email address.

Input Parameters

string
Exact user email address to match.
integer
Maximum users to return in this page (1-100).
string ("asc" | "desc")
Creation-time order for returned users.
string
Cursor returned by a previous call. Omit for the first page.
string
Return users belonging to this WorkOS organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_RESEND_INVITATIONSend another real invitation email to the existing recipient of a pending WorkOS AuthKit invitation. This externally visible email delivery cannot be undone. The response excludes the invitation token and acceptance URL.

Input Parameters

string ("af" | "am" | "ar" | "bg" | "bn" | "bs" | "ca" | "cs" | "da" | "de" | "de-DE" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-US" | "es" | "es-419" | "es-ES" | "es-US" | "et" | "fa" | "fi" | "fil" | "fr" | "fr-BE" | "fr-CA" | "fr-FR" | "fy" | "gl" | "gu" | "ha" | "he" | "hi" | "hr" | "hu" | "hy" | "id" | "is" | "it" | "it-IT" | "ja" | "jv" | "ka" | "kk" | "km" | "kn" | "ko" | "lt" | "lv" | "mk" | "ml" | "mn" | "mr" | "ms" | "my" | "nb" | "ne" | "nl" | "nl-BE" | "nl-NL" | "nn" | "no" | "pa" | "pl" | "pt" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sq" | "sr" | "sv" | "sw" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "uz" | "vi" | "zh" | "zh-CN" | "zh-HK" | "zh-TW" | "zu")
Supported WorkOS locale for the real invitation email.
string
required
Pending WorkOS invitation to email again. Calling this tool sends a real email to the invitation’s existing recipient.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_REVOKE_INVITATIONRevoke a pending AuthKit invitation so it can no longer be accepted.

Input Parameters

string
required
WorkOS invitation to revoke.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_SEND_INVITATIONCreate an AuthKit invitation and immediately send a real invitation email to the recipient. This externally visible email delivery cannot be undone. Use only when the recipient and delivery are intentional. The output omits the sensitive acceptance token and acceptance URL.

Input Parameters

string
required
Recipient email address. Calling this tool sends a real email.
string ("af" | "am" | "ar" | "bg" | "bn" | "bs" | "ca" | "cs" | "da" | "de" | "de-DE" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-US" | "es" | "es-419" | "es-ES" | "es-US" | "et" | "fa" | "fi" | "fil" | "fr" | "fr-BE" | "fr-CA" | "fr-FR" | "fy" | "gl" | "gu" | "ha" | "he" | "hi" | "hr" | "hu" | "hy" | "id" | "is" | "it" | "it-IT" | "ja" | "jv" | "ka" | "kk" | "km" | "kn" | "ko" | "lt" | "lv" | "mk" | "ml" | "mn" | "mr" | "ms" | "my" | "nb" | "ne" | "nl" | "nl-BE" | "nl-NL" | "nn" | "no" | "pa" | "pl" | "pt" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sq" | "sr" | "sv" | "sw" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "uz" | "vi" | "zh" | "zh-CN" | "zh-HK" | "zh-TW" | "zu")
Supported locale in which WorkOS renders the hosted invitation email.
string
Role granted when the organization invitation is accepted.
integer
Number of days the invitation remains valid (1-30).
string
WorkOS user whose name will appear as the inviter in the email.
string
WorkOS organization the recipient will join after accepting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_SET_ORGANIZATION_MEMBERSHIP_STATUSActivate or deactivate a WorkOS organization membership without deleting it. Deactivation removes access but can be reversed by setting the status to active.

Input Parameters

string ("active" | "inactive")
required
Desired access state. Active reactivates an inactive membership; inactive deactivates an active membership. Pending is not supported.
string
required
WorkOS organization membership whose access state will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_UPDATE_ORGANIZATIONUpdate selected properties of an existing WorkOS organization.

Input Parameters

string
New organization name.
object
Replacement metadata with at most 50 pairs, or null to clear it. Keys may contain up to 40 characters and values up to 600 characters.
array
Replacement domain records. Each record must include a domain and verification state.
string
Replacement ASCII external ID, or null to clear it.
string
required
WorkOS organization ID.
string
Stripe customer ID associated with the organization.
boolean
New outside-profile sign-in policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_UPDATE_ORGANIZATION_MEMBERSHIP_ROLESReplace the role assignment on an existing WorkOS organization membership.

Input Parameters

string
One replacement role slug. Omit both role fields to use the default role; do not provide this with role_slugs.
array
Complete replacement role set for environments with Multiple Roles enabled. Omit both role fields to use the default role; do not provide this with role_slug.
string
required
WorkOS organization membership ID whose roles will be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKOS_UPDATE_USERUpdate selected profile fields on an AuthKit user without invoking email delivery flows.

Input Parameters

string
Replacement full name.
string
Replacement email address.
string
Preferred locale, or null to clear it.
string
required
WorkOS user ID.
object
Replacement metadata with at most 50 pairs, or null to clear it. Keys may contain up to 40 characters and values up to 600 characters.
string
Replacement last name.
string
Replacement first name.
string
Replacement ASCII external ID, or null to clear it.
boolean
Replacement verification state. Set this only from trusted evidence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not