WorkOS

WorkOS integration (Developer Tools). Imported from open-connector.

API key14 toolshttps://api.workos.com

GET

workos_list_users

List WorkOS AuthKit users with optional cursor and identity filters.

/user_management/users

6 parameters

Param	Type	Required	Description
before	string	optional	An object ID that defines the cursor position before the requested page.
after	string	optional	An object ID that defines the cursor position after the requested page.
limit	integer	optional	Upper limit on the number of objects to return, between 1 and 100.
order	string	optional	Order the results by creation time.
organization_id	string	optional	Filter users by the organization they are members of.
email	string	optional	Filter users by their email address.

GET

workos_get_user

Get a WorkOS AuthKit user by ID.

/user_management/users/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The unique ID of the user.

POST

workos_create_user

Create a WorkOS AuthKit user in the current environment.

/user_management/users

8 parameters

Param	Type	Required	Description
email	string	required	The email address of the user.
first_name	string	optional	The first name of the user.
last_name	string	optional	The last name of the user.
name	string	optional	The user's full name.
email_verified	boolean	optional	Whether the user's email address was previously verified.
metadata	object	optional	Metadata key/value pairs associated with the resource.
external_id	string	optional	The external identifier of the user.
password	string	optional	The password to set for the user.

PUT

workos_update_user

Update properties of an existing WorkOS AuthKit user.

/user_management/users/{id}

8 parameters

Param	Type	Required	Description
id	string	required	The unique ID of the user.
first_name	string	optional	The first name of the user.
last_name	string	optional	The last name of the user.
name	string	optional	The user's full name.
email_verified	boolean	optional	Whether the user's email address was previously verified.
metadata	object	optional	Metadata key/value pairs associated with the resource.
external_id	string	optional	The external identifier of the user.
password	string	optional	The password to set for the user.

GET

workos_list_organizations

List WorkOS organizations with optional cursor, domain, and text filters.

/organizations

6 parameters

Param	Type	Required	Description
before	string	optional	An object ID that defines the cursor position before the requested page.
after	string	optional	An object ID that defines the cursor position after the requested page.
limit	integer	optional	Upper limit on the number of objects to return, between 1 and 100.
order	string	optional	Order the results by creation time.
domains	array	optional	Domains to match against organizations.
search	string	optional	Search text matched against organization names.

GET

workos_get_organization

Get a WorkOS organization by ID.

/organizations/{id}

1 parameter

Param	Type	Required	Description
id	string	required	Unique identifier of the organization.

POST

workos_create_organization

Create a WorkOS organization in the current environment.

/organizations

5 parameters

Param	Type	Required	Description
name	string	required	The name of the organization.
allow_profiles_outside_organization	boolean	optional	Whether the organization allows profiles from outside the organization to sign …
domain_data	array	optional	Domains associated with the organization, including verification state.
metadata	object	optional	Metadata key/value pairs associated with the resource.
external_id	string	optional	An external identifier for the organization.

PUT

workos_update_organization

Update properties of an existing WorkOS organization.

/organizations/{id}

6 parameters

Param	Type	Required	Description
id	string	required	Unique identifier of the organization.
name	string	optional	The name of the organization.
allow_profiles_outside_organization	boolean	optional	Whether the organization allows profiles from outside the organization to sign …
domain_data	array	optional	Domains associated with the organization, including verification state.
metadata	object	optional	Metadata key/value pairs associated with the resource.
external_id	string	optional	An external identifier for the organization.

GET

workos_list_organization_memberships

List WorkOS organization memberships filtered by user, organization, or membership status.

/user_management/organization_memberships

7 parameters

Param	Type	Required	Description
before	string	optional	An object ID that defines the cursor position before the requested page.
after	string	optional	An object ID that defines the cursor position after the requested page.
limit	integer	optional	Upper limit on the number of objects to return, between 1 and 100.
order	string	optional	Order the results by creation time.
organization_id	string	optional	The ID of the organization which the user belongs to.
user_id	string	optional	The ID of the user.
statuses	array	optional	Statuses to include in the membership list.

GET

workos_get_organization_membership

Get a WorkOS organization membership by ID.

/user_management/organization_memberships/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The unique ID of the organization membership.

POST

workos_create_organization_membership

Create an active WorkOS organization membership for a user and organization.

/user_management/organization_memberships

4 parameters

Param	Type	Required	Description
user_id	string	required	The ID of the user.
organization_id	string	required	The ID of the organization which the user belongs to.
role_slug	string	optional	A single role identifier.
role_slugs	array	optional	Role identifiers to assign to the user.

PUT

workos_update_organization_membership

Update roles on an existing WorkOS organization membership.

/user_management/organization_memberships/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The unique ID of the organization membership.
role_slug	string	optional	A single role identifier.
role_slugs	array	optional	Role identifiers to assign to the user.

PUT

workos_deactivate_organization_membership

Deactivate an active WorkOS organization membership.

/user_management/organization_memberships/{id}/deactivate

1 parameter

Param	Type	Required	Description
id	string	required	The unique ID of the organization membership.

PUT

workos_reactivate_organization_membership

Reactivate an inactive WorkOS organization membership.

/user_management/organization_memberships/{id}/reactivate

1 parameter

Param	Type	Required	Description
id	string	required	The unique ID of the organization membership.