All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
2.2.0 (2026-03-25)
- implement missing fields on user objects (ba1daa4)
- implement the missing fields on user objects (778fb40)
2.1.0 (2026-03-13)
- add external_id and metadata to organization resource (4bde9d4)
- add external_id and metadata to organization resource (beb9dbd)
- add external_id lookup to organization data source (d9f645b)
- add permission resource, data source, and organization role permission resource (d9ded58)
- add permission resource, data source, and organization role permission resource (10fd884)
- prevent updated_at drift and allow clearing description on permission resource (0df2991)
- prevent updated_at drift on re-apply (36a1b9e)
- prevent updated_at drift on re-apply of unchanged state (1ad7f91), closes #5
- resolve updated_at drift on update and email_verified reset (3f93787)
- validate domain uniqueness across organizations (0658b1f)
- validate domain uniqueness across organizations (14e5d2e), closes #8
workos_organization_roleresource - Manage organization authorization rolesworkos_organization_roledata source - Look up organization roles by slug or ID
- BREAKING:
workos_connectionresource - WorkOS API does not support creating/updating connections via API; use the Dashboard instead. The read-only data source is still available. - BREAKING:
workos_directoryresource - WorkOS API does not support creating/updating directories via API; use the Dashboard instead. The read-only data source is still available. - BREAKING:
workos_webhookresource - WorkOS has no public webhook management API; use the Dashboard instead. - BREAKING:
allow_profiles_outside_organizationattribute onworkos_organizationresource and data source - WorkOS API no longer accepts this parameter.
workos_userresource:email_verifiedis now always sent on updates, preventing drift when email changes reset verification statusworkos_organization_membershipresource:role_slugis preserved from plan/state when the API omits it from responsesworkos_userdata source tests: replaced hardcoded placeholder IDs with dynamically created resourcesworkos_organization_roleresource: slug is now prefixed withorg-per WorkOS API requirement
- Provider configuration with
api_key,client_id, andbase_urlattributes - Environment variable support:
WORKOS_API_KEY,WORKOS_CLIENT_ID,WORKOS_BASE_URL - Rate limiting with exponential backoff and Retry-After header support
- Comprehensive error handling with typed errors
-
workos_organization- Manage WorkOS organizations- Full CRUD operations
- Domain management
- Import support
-
workos_user- Manage AuthKit users- Email and name management
- Password and password hash support for authentication
- Email verification status
- Import support
-
workos_organization_membership- Manage user-organization associations- User and organization linking
- Role assignment support
- Import support
workos_organization- Look up organizations by ID or domainworkos_connection- Look up SSO connections by ID or organization/type (read-only)workos_directory- Look up directories by ID or organization (read-only)workos_directory_user- Look up directory-synced users by ID or emailworkos_directory_group- Look up directory-synced groups by ID or nameworkos_user- Look up AuthKit users by ID or email
- Auto-generated documentation using terraform-plugin-docs
- Comprehensive examples for all resources and data sources
- Schema descriptions with Markdown support
- API keys marked as sensitive and never logged
- User passwords marked as sensitive (write-only)