The WorkOS Kotlin library provides convenient access to the WorkOS API from applications written in JVM compatible languages.

See the API Reference for Kotlin/Java usage examples.

<dependency>
  <groupId>com.workos</groupId>
  <artifactId>workos</artifactId>
  <version>VERSION</version>
</dependency>

Customers using Maven who receive a "NoSuchMethodError" error referencing Fuel may need to specify a version of Kotlin greater than 1.4.0.

<properties>
    <kotlin.version>1.4.0</kotlin.version>
</properties>

dependencies {
  implementation 'com.workos:workos:VERSION'
}

dependencies {
  implementation("com.workos:workos:VERSION")
}

import com.workos.WorkOS;

WorkOS workos = new WorkOS("WORKOS_API_KEY");

// Access different domains of the WorkOS API through the following properties
// workos.directorySync
// workos.organizations
// workos.passwordless
// workos.portal
// workos.sso
// workos.webhooks

For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.

See full examples at https://github.com/workos-inc/java-example-applications.

• Single Sign-On Guide
• Directory Sync Guide
• Admin Portal Guide
• Magic Link Guide