> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WorkOS

> How to set up the WorkOS connector, plus the actions that are available.

![WorkOS](https://stackone-logos.com/api/workos/filled/svg)

Betav0.1.1[See changelog](https://docs.stackone.com/connectors/workos/changelog.md)

[234 actions](#actions) · 1 auth method

IAM
AI
Security
Users

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/workos/guides/connector-profile/api-key.md)
>
> No app registration required. The secret key is bound to a single WorkOS environment, so Staging and Production each nee...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/workos/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

234 actions

ActionDescription

List Agent Blueprints`workos_list_agent_blueprints`

List agent blueprints

List Agent Instances`workos_list_agent_instances`

List agent instances

List Agent Instance Sessions`workos_list_agent_sessions`

List agent instance sessions

Get An Agent Blueprint`workos_get_agent_blueprint`

Get an agent blueprint

Get An Agent Instance`workos_get_agent_instance`

Get an agent instance

Get An Agent Registration`workos_get_agent_registration`

Get an agent registration

Get An Agent Instance Session`workos_get_agent_session`

Get an agent instance session

Create An Agent Blueprint`workos_create_agent_blueprint`

Create an agent blueprint

Mint An Agent Token`workos_create_agent_blueprint_token`

Mint an agent token

Update An Agent Blueprint`workos_update_agent_blueprint`

Update an agent blueprint

Delete An Agent Blueprint`workos_delete_agent_blueprint`

Delete an agent blueprint

Delete An Agent Instance`workos_delete_agent_instance`

Delete an agent instance

Link A Claim Attempt To An External User`workos_link_agent_claim_attempt`

Link a claim attempt to an external user

Revoke An Agent Instance Session`workos_revoke_agent_session`

Revoke an agent instance session

Validate An Agent Token`workos_validate_agent_blueprint_token`

Validate an agent token

Validate An Agent Credential`workos_validate_agent_credential`

Validate an agent credential

List API Keys For An Organization`workos_list_organization_api_keys`

List API keys for an organization

Create An API Key For An Organization`workos_create_organization_api_key`

Create an API key for an organization

Delete An API Key`workos_delete_api_key`

Delete an API key

Expire An API Key`workos_expire_api_key`

Expire an API key

Validate API Key`workos_validate_api_key`

Validate API key

List Audit Log Actions`workos_list_audit_log_actions`

Get a list of all Audit Log actions in the current environment.

Get Audit Log Export`workos_get_audit_log_export`

Get an Audit Log Export. The URL will expire after 10 minutes. If the export is needed again at a later time, refetching...

List Audit Log Schemas`workos_list_audit_log_schemas`

Get a list of all schemas for the Audit Logs action identified by `:name`.

Get Audit Log Retention`workos_get_audit_log_retention`

Get the configured event retention period for the given Organization.

Create Audit Log Event`workos_create_audit_log_event`

Create an Audit Log Event. This API supports idempotency which guarantees that performing the same operation multiple ti...

Create Audit Log Export`workos_create_audit_log_export`

Create an Audit Log Export. Exports are scoped to a single organization within a specified date range.

Create Audit Log Schema`workos_create_audit_log_schema`

Creates a new Audit Log schema used to validate the payload of incoming Audit Log Events. If the `action` does not exist...

Set Audit Log Retention`workos_set_audit_log_retention`

Set the event retention period for the given Organization.

List CORS Origins`workos_list_cors_origins`

List CORS origins

List Redirect URIs`workos_list_redirect_uris`

List redirect URIs

Get JWT Template`workos_get_jwt_template`

Get JWT template

Create A CORS Origin`workos_create_cors_origin`

Create a CORS origin

Create A Redirect URI`workos_create_redirect_uri`

Create a redirect URI

Update JWT Template`workos_set_jwt_template`

Update JWT template

Delete A Redirect URI`workos_delete_redirect_uri`

Delete a redirect URI

List Role Assignments For A Group`workos_list_group_role_assignments`

List role assignments for a group

List Membership Resource Permissions`workos_list_membership_resource_permissions`

List effective permissions for an organization membership on a resource

List Resources For Organization Membership`workos_list_membership_resources`

List resources for organization membership

List Role Assignments`workos_list_membership_role_assignments`

List role assignments

List Permissions`workos_list_permissions`

List permissions

List Organization Memberships For Resource`workos_list_resource_memberships`

List organization memberships for resource

List Memberships For A Resource By External ID`workos_list_resource_memberships_by_ext_id`

List memberships for a resource by external ID

List Resource Permissions By Ext ID`workos_list_resource_permissions_by_ext_id`

List effective permissions for an organization membership on a resource by external ID

List Role Assignments For A Resource`workos_list_resource_role_assignments`

List role assignments for a resource

List Role Assignments For A Resource By External ID`workos_list_resource_role_assigns_by_ext_id`

List role assignments for a resource by external ID

List Resources`workos_list_resources`

List resources

Get A Group Role Assignment`workos_get_group_role_assignment`

Get a group role assignment

Get A Custom Role`workos_get_organization_role`

Get a custom role

Get A Permission`workos_get_permission`

Get a permission

Get A Resource`workos_get_resource`

Get a resource

Get A Resource By External ID`workos_get_resource_by_external_id`

Get a resource by external ID

Get An Environment Role`workos_get_role`

Get an environment role

Assign A Role To A Group`workos_create_group_role_assignment`

Assign a role to a group

Assign A Role`workos_create_membership_role_assignment`

Assign a role

Create A Custom Role`workos_create_organization_role`

Create a custom role

Create A Permission`workos_create_permission`

Create a permission

Create An Authorization Resource`workos_create_resource`

Create an authorization resource

Create An Environment Role`workos_create_role`

Create an environment role

Add A Permission To A Custom Role`workos_add_organization_role_permission`

Add a permission to a custom role

Add A Permission To An Environment Role`workos_add_role_permission`

Add a permission to an environment role

Update A Custom Role`workos_update_organization_role`

Update a custom role

Update A Permission`workos_update_permission`

Update a permission

Update A Resource`workos_update_resource`

Update a resource

Update A Resource By External ID`workos_update_resource_by_external_id`

Update a resource by external ID

Update An Environment Role`workos_update_role`

Update an environment role

Replace All Role Assignments For A Group`workos_set_group_role_assignments`

Replace all role assignments for a group

Set Permissions For A Custom Role`workos_set_organization_role_permissions`

Set permissions for a custom role

Set Permissions For An Environment Role`workos_set_role_permissions`

Set permissions for an environment role

Check Authorization`workos_check_membership_permission`

Check authorization

Remove A Group Role Assignment`workos_delete_group_role_assignment`

Remove a group role assignment

Remove Group Role Assignments By Criteria`workos_delete_group_roles_by_criteria`

Remove group role assignments by criteria

Remove A Role Assignment By ID`workos_delete_membership_role_assignment`

Remove a role assignment by ID

Remove A Role Assignment`workos_delete_membership_roles_by_criteria`

Remove a role assignment

Delete A Custom Role`workos_delete_organization_role`

Delete a custom role

Remove A Permission From A Custom Role`workos_delete_organization_role_permission`

Remove a permission from a custom role

Delete A Permission`workos_delete_permission`

Delete a permission

Delete An Authorization Resource`workos_delete_resource`

Delete an authorization resource

Delete An Authorization Resource By External ID`workos_delete_resource_by_external_id`

Delete an authorization resource by external ID

List Client Secrets For A Connect Application`workos_list_application_client_secrets`

List Client Secrets for a Connect Application

List Connect Applications`workos_list_connect_applications`

List Connect Applications

Get A Connect Application`workos_get_connect_application`

Get a Connect Application

Create A New Client Secret For A Connect Application`workos_create_application_client_secret`

Create a new client secret for a Connect Application

Create A Connect Application`workos_create_connect_application`

Create a Connect Application

Update A Connect Application`workos_update_connect_application`

Update a Connect Application

Delete A Connect Application`workos_delete_connect_application`

Delete a Connect Application

List Connections`workos_list_connections`

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

Get Connection`workos_get_connection`

Get the details of an existing connection.

Create Connection`workos_create_connection`

Creates a new connection for an organization. Provide `saml_options` or `oidc_options` to configure the identity provide...

Update Connection`workos_update_connection`

Updates an existing connection. Only the provided fields are changed; fields that accept `null` are reset to their defau...

Delete Connection`workos_delete_connection`

Permanently deletes an existing connection. It cannot be undone.

List Data Integrations`workos_list_data_integrations`

List data integrations

Create A Data Integration`workos_create_data_integration`

Create a data integration

List Providers For An Organization`workos_list_organization_data_providers`

List providers for an organization

List Providers For A User`workos_list_user_data_providers`

List providers for a user

Get A Data Integration`workos_get_data_integration`

Get a data integration

Get An Organization-owned Data Integration`workos_get_data_integration_organization`

Get an organization-owned data integration

Get An Organization Connected Account`workos_get_organization_connected_account`

Get an organization connected account

Get A Connected Account`workos_get_user_connected_account`

Get a connected account

Create Another API Key Connected Account`workos_create_data_integration_api_key`

Create another API key connected account

Create Another Client Credentials Connected Account`workos_create_data_integration_client_credential`

Create another client credentials connected account

Vend Credentials For A Connected Account`workos_get_data_integration_credentials`

Vend credentials for a connected account

Get An Access Token For A Connected Account`workos_get_data_integration_token`

Get an access token for a connected account

Import An Organization Connected Account`workos_import_organization_connected_account`

Import an organization connected account

Import A Connected Account`workos_import_user_connected_account`

Import a connected account

Update A Data Integration`workos_update_data_integration`

Update a data integration

Update An Organization Connected Account`workos_update_organization_connected_account`

Update an organization connected account

Update A Connected Account`workos_update_user_connected_account`

Update a connected account

Upsert An API Key For A Connected Account`workos_set_data_integration_api_key`

Upsert an API key for a connected account

Upsert Client Credentials For A Connected Account`workos_set_data_integration_client_credential`

Upsert client credentials for a connected account

Update An Organization-owned Data Integration`workos_update_data_integration_organization`

Update an organization-owned data integration

Get Authorization URL`workos_get_data_integration_authorize_url`

Get authorization URL

Delete A Data Integration`workos_delete_data_integration`

Delete a data integration

Delete An Organization-owned Data Integration`workos_delete_data_integration_organization`

Delete an organization-owned data integration

Delete An Organization Connected Account`workos_delete_organization_connected_account`

Delete an organization connected account

Delete A Connected Account`workos_delete_user_connected_account`

Delete a connected account

List Directories`workos_list_directories`

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

Get Directory`workos_get_directory`

Get the details of an existing directory.

Sync Directory`workos_sync_directory`

Request an asynchronous sync from the directory provider. Currently supports Google Workspace directories in linked or v...

Delete Directory`workos_delete_directory`

Permanently deletes an existing directory. It cannot be undone.

List Directory Groups`workos_list_directory_groups`

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

Get Directory Group`workos_get_directory_group`

Get the details of an existing Directory Group.

List Directory Users`workos_list_directory_users`

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

Get Directory User`workos_get_directory_user`

Get the details of an existing Directory User.

Get An Email Verification Code`workos_get_email_verification`

Get an email verification code

Verify Email`workos_confirm_user_email_verification`

Verify email

Send Verification Email`workos_send_user_email_verification`

Send verification email

List Events`workos_list_events`

List events for the current environment.

List Feature Flags`workos_list_feature_flags`

List feature flags

List Enabled Feature Flags For An Organization`workos_list_organization_feature_flags`

List enabled feature flags for an organization

List Enabled Feature Flags For A User`workos_list_user_feature_flags`

List enabled feature flags for a user

Get A Feature Flag`workos_get_feature_flag`

Get a feature flag

Add A Feature Flag Target`workos_create_feature_flag_target`

Add a feature flag target

Remove A Feature Flag Target`workos_delete_feature_flag_target`

Remove a feature flag target

Disable A Feature Flag`workos_disable_feature_flag`

Disable a feature flag

Enable A Feature Flag`workos_enable_feature_flag`

Enable a feature flag

List Group Members`workos_list_group_memberships`

List Group members

List Membership Groups`workos_list_membership_groups`

List groups

List Organization Groups`workos_list_organization_groups`

List groups

Get A Group`workos_get_organization_group`

Get a group

Add A Member To A Group`workos_create_group_membership`

Add a member to a Group

Create A Group`workos_create_organization_group`

Create a group

Update A Group`workos_update_organization_group`

Update a group

Remove A Member From A Group`workos_delete_group_membership`

Remove a member from a Group

Delete A Group`workos_delete_organization_group`

Delete a group

List Invitations`workos_list_invitations`

Get a list of all of invitations matching the criteria specified.

Get Invitation`workos_get_invitation`

Get the details of an existing invitation.

Get Invitation By Token`workos_get_invitation_by_token`

Retrieve an existing invitation using the token.

Send Invitation`workos_send_invitation`

Sends an invitation email to the recipient.

Accept Invitation`workos_accept_invitation`

Accepts an invitation and, if linked to an organization, activates the user's membership in that organization.

Resend Invitation`workos_resend_invitation`

Resends an invitation email to the recipient. The invitation must be in a pending state.

Revoke Invitation`workos_revoke_invitation`

Revokes an existing invitation.

List IT Contacts`workos_list_organization_it_contacts`

List IT contacts

Create An IT Contact`workos_create_organization_it_contact`

Create an IT contact

Delete An IT Contact`workos_delete_organization_it_contact`

Delete an IT contact

Invite An IT Contact`workos_invite_organization_it_contact`

Invite an IT contact

Revoke An IT Contact's Invitation`workos_revoke_organization_it_contact`

Revoke an IT contact's invitation

List Authentication Factors`workos_list_user_auth_factors`

List authentication factors

Get Factor`workos_get_auth_factor`

Get Factor

Enroll An Authentication Factor`workos_create_user_auth_factor`

Enroll an authentication factor

Challenge Factor`workos_challenge_auth_factor`

Challenge Factor

Delete Factor`workos_delete_auth_factor`

Delete Factor

Enroll Factor`workos_enroll_auth_factor`

Enroll Factor

Verify Challenge`workos_verify_auth_challenge`

Verify Challenge

Get Organization Domain`workos_get_organization_domain`

Get the details of an existing organization domain.

Create Organization Domain`workos_create_organization_domain`

Creates a new Organization Domain.

Verify Organization Domain`workos_verify_organization_domain`

Initiates verification process for an Organization Domain.

Delete Organization Domain`workos_delete_organization_domain`

Permanently deletes an organization domain. It cannot be undone.

List Organization Memberships`workos_list_organization_memberships`

Get a list of all organization memberships matching the criteria specified. At least one of `user_id` or \`organization\_i...

Get Organization Membership`workos_get_organization_membership`

Get the details of an existing organization membership.

Create Organization Membership`workos_create_organization_membership`

Creates a new `active` organization membership for the given organization and user. Calling this API with an organizatio...

Update Organization Membership`workos_update_organization_membership`

Update the details of an existing organization membership.

Deactivate Organization Membership`workos_deactivate_organization_membership`

Deactivates an `active` organization membership. Emits an organization\_membership.updated...

Reactivate Organization Membership`workos_reactivate_organization_membership`

Reactivates an `inactive` organization membership, retaining the pre-existing role(s). Emits an organization\_membership...

Delete Organization Membership`workos_delete_organization_membership`

Permanently deletes an existing organization membership. It cannot be undone.

List Organizations`workos_list_organizations`

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

Get Organization`workos_get_organization`

Get the details of an existing organization.

Get Organization By External ID`workos_get_organization_by_external_id`

Get the details of an existing organization by an external identifier...

Get Organization Audit Log Configuration`workos_get_organization_audit_log_config`

Get the unified view of audit log trail and stream configuration for an organization.

Create Organization`workos_create_organization`

Creates a new organization in the current environment.

Update Organization`workos_update_organization`

Updates an organization in the current environment.

Delete Organization`workos_delete_organization`

Permanently deletes an organization in the current environment. It cannot be undone.

Get A Password Reset Token`workos_get_password_reset`

Get a password reset token

Create A Password Reset Token`workos_create_password_reset`

Create a password reset token

Reset The Password`workos_confirm_password_reset`

Reset the password

Get A Team`workos_get_platform_team`

Get a team

Create A Team`workos_create_platform_team`

Create a team

Create Portal Link`workos_create_portal_link`

Generate a Portal Link scoped to an Organization.

Create An Attempt`workos_create_radar_attempt`

Create an attempt

Add An Entry To A Radar List`workos_add_radar_list_entry`

Add an entry to a Radar list

Update A Radar Attempt`workos_update_radar_attempt`

Update a Radar attempt

Remove An Entry From A Radar List`workos_delete_radar_list_entry`

Remove an entry from a Radar list

List Roles`workos_list_roles`

List all environment roles in priority order.

List Organization Roles`workos_list_organization_roles`

Get a list of all roles that apply to an organization. This includes both environment roles and custom roles, returned i...

List IdP Signing Certificates`workos_list_connection_idp_signing_certs`

List IdP signing certificates

List SP Encryption Certificates`workos_list_connection_sp_encryption_certs`

List SP encryption certificates

Get The SP Signing Certificate`workos_get_connection_sp_signing_cert`

Get the SP signing certificate

Create An IdP Signing Certificate`workos_create_connection_idp_signing_cert`

Create an IdP signing certificate

Create An SP Encryption Certificate`workos_create_connection_sp_encryption_cert`

Create an SP encryption certificate

Create An SP Signing Certificate`workos_create_connection_sp_signing_cert`

Create an SP signing certificate

Delete An IdP Signing Certificate`workos_delete_connection_idp_signing_cert`

Delete an IdP signing certificate

Delete An SP Encryption Certificate`workos_delete_connection_sp_encryption_cert`

Delete an SP encryption certificate

Delete The SP Signing Certificate`workos_delete_connection_sp_signing_cert`

Delete the SP signing certificate

Revoke Session`workos_revoke_session`

Revoke Session

List Users`workos_list_users`

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

Get User`workos_get_user`

Get the details of an existing user.

List User Sessions`workos_list_user_sessions`

Get a list of all active sessions for a specific user.

Get User Identities`workos_get_user_identities`

Get a list of identities associated with the user. A user can have multiple associated identities after going through i...

Get User By External ID`workos_get_user_by_external_id`

Get the details of an existing user by an external identifier...

Create User`workos_create_user`

Create a new user in the current environment.

Update User`workos_update_user`

Updates properties of a user. The omitted properties will be left unchanged.

Delete User`workos_delete_user`

Permanently deletes a user in the current environment. It cannot be undone.

List Object Versions`workos_list_secret_versions`

List object versions

List Objects`workos_list_secrets`

List objects

Read An Object By ID`workos_get_secret`

Read an object by ID

Read An Object By Name`workos_get_secret_by_name`

Read an object by name

Describe An Object`workos_describe_secret`

Describe an object

Create An Object`workos_create_secret`

Create an object

Create A Data Key`workos_create_vault_data_key`

Create a data key

Update An Object`workos_update_secret`

Update an object

Decrypt A Data Key`workos_decrypt_vault_data_key`

Decrypt a data key

Delete An Object`workos_delete_secret`

Delete an object

Re-encrypt A Data Key`workos_rekey_vault_data_key`

Re-encrypt a data key

List Waitlist Entries`workos_list_waitlist_entries`

List waitlist entries

List Waitlists`workos_list_waitlists`

List waitlists

Get A Waitlist`workos_get_waitlist`

Get a waitlist

Create A Waitlist Entry`workos_create_waitlist_entry`

Create a waitlist entry

Approve A Waitlist Entry`workos_approve_waitlist_entry`

Approve a waitlist entry

Delete A Waitlist Entry`workos_delete_waitlist_entry`

Delete a waitlist entry

Deny A Waitlist Entry`workos_deny_waitlist_entry`

Deny a waitlist entry

List Webhook Endpoints`workos_list_webhook_endpoints`

List Webhook Endpoints

Create A Webhook Endpoint`workos_create_webhook_endpoint`

Create a Webhook Endpoint

Update A Webhook Endpoint`workos_update_webhook_endpoint`

Update a Webhook Endpoint

Delete A Webhook Endpoint`workos_delete_webhook_endpoint`

Delete a Webhook Endpoint


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.