WorkOS
Purpose
Syncs WorkOS users, organizations, memberships, roles, directories, directory users and groups, applications, API keys, and invitations.
tip
Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into SubImage's managed vault. See Secrets for details.
Required Fields
| Field | Secret? | Description |
|---|---|---|
workos_api_key |
Yes | WorkOS API key with read access to User Management, Directory Sync, and Organizations |
workos_client_id |
No | WorkOS environment client ID (starts with client_) |
Setup Steps
- In the WorkOS Dashboard, go to API Keys. Copy your Client ID.
- Create or copy an API key (starts with
sk_) with read access to User Management, Directory Sync, and Organizations. - In SubImage, enter
workos_api_key(key value or its AWS Secret ARN) andworkos_client_id. Save the module.