clockwisehq/workos-kotlin

Official Kotlin SDK for interacting with the WorkOS API

WorkOS Kotlin

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

Documentation

See the API Reference for Kotlin/Java usage examples.

Installation

Apache Maven

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

Gradle (Groovy DSL)

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

Gradle (Kotlin DSL)

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

Use

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

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

More Information

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