> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/workos.md).

# WorkOS

Connect to WorkOS to manage AuthKit users, organizations, Directory Sync, and Admin Portal links.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| WorkOS    | Secret API key |

### WorkOS

Connect to WorkOS with a secret API key to manage AuthKit users, organizations, Directory Sync, and Admin Portal links.

#### Set up in WorkOS

1. Prepare the WorkOS account or service that the workflow will access. Grant access to the required resources and operations.
2. **Secret API key:** Your WorkOS secret API key. Create or rotate it in the WorkOS Dashboard. Production keys are shown only once.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **WorkOS**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                                                                                |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Secret API key | Yes      | Your WorkOS secret API key. Create or rotate it in the WorkOS Dashboard. Production keys are shown only once. [Provider instructions](https://workos.com/docs/reference/api-authentication). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **WorkOS** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create user

Create a WorkOS user for a customer or workforce identity.

#### Inputs

| Field       | Type     | Required | Description                                   |
| ----------- | -------- | -------- | --------------------------------------------- |
| Email       | string   | Yes      | The user's email address.                     |
| First name  | string   | No       | The user's given name.                        |
| Last name   | string   | No       | The user's family name.                       |
| External ID | string   | No       | A stable identifier from another system.      |
| Metadata    | textarea | No       | Optional string-valued metadata for the user. |

#### Outputs

| Field | Type   | Description                       |
| ----- | ------ | --------------------------------- |
| User  | object | The WorkOS user that was created. |

### List Directory Users

Find users synchronized from WorkOS Directory Sync.

#### Inputs

| Field           | Type            | Required | Description                                                                                         |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Directory       | select (string) | No       | Choose the directory whose synchronized users to return. Options load from the selected connection. |
| Directory group | select (string) | No       | Choose a synchronized group whose users to return. Options load from the selected connection.       |
| Email           | string          | No       | Return a directory user with this email address.                                                    |
| Maximum results | integer         | No       | The maximum number of directory users to return. Minimum: 1. Maximum: 500. Default: 100.            |
| Starting cursor | string          | No       | Resume after this cursor from an earlier result.                                                    |

#### Outputs

| Field           | Type          | Description                                               |
| --------------- | ------------- | --------------------------------------------------------- |
| Directory users | object\_array | The matching synchronized users.                          |
| User count      | integer       | The number of directory users returned.                   |
| Next cursor     | string        | The cursor for the next batch, when more users may exist. |

### Create organization

Create a customer organization in WorkOS.

#### Inputs

| Field             | Type     | Required | Description                                           |
| ----------------- | -------- | -------- | ----------------------------------------------------- |
| Organization name | string   | Yes      | The customer-facing organization name.                |
| External ID       | string   | No       | A stable organization identifier from another system. |
| Metadata          | textarea | No       | Optional string-valued metadata for the organization. |

#### Outputs

| Field        | Type   | Description                               |
| ------------ | ------ | ----------------------------------------- |
| Organization | object | The WorkOS organization that was created. |

### Generate Admin Portal link

Create a short-lived self-service setup link for an organization administrator.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                                                                 |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Organization | select (string) | Yes      | Choose the organization whose administrator will use the Portal. Options load from the selected connection.                                                                                 |
| Setup task   | select (string) | No       | The Admin Portal setup flow to open. Available values: Single sign-on, Directory Sync, Audit Logs, Log Streams, Domain verification, Certificate renewal, Bring your own key. Default: sso. |

#### Outputs

| Field             | Type   | Description                       |
| ----------------- | ------ | --------------------------------- |
| Admin Portal link | string | The short-lived Admin Portal URL. |

### Send Magic Auth code

Request a one-time Magic Auth email using WorkOS default email delivery.

#### Inputs

| Field | Type   | Required | Description                                     |
| ----- | ------ | -------- | ----------------------------------------------- |
| Email | string | Yes      | The email address that should receive the code. |

#### Outputs

| Field              | Type   | Description                               |
| ------------------ | ------ | ----------------------------------------- |
| Magic Auth request | object | The Magic Auth request created by WorkOS. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/workos.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
