Directory sync

Use scalekitClient.directories() for SCIM directory sync—listing providers, users, and groups provisioned from an IdP.

Use this after SSO is in place when the customer provisions users via SCIM.

getDirectory

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asyncgetDirectory

Runs getDirectory and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

returnsDirectory

The response payload for this operation.

scalekitClient.directories().getDirectory("dir_123", "org_123");

listDirectories

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asynclistDirectories

Runs listDirectories and returns the result.

paramorganizationIdString

Organization ID.

returnsListDirectoriesResponse

Paginated results.

scalekitClient.directories().listDirectories("org_123");

listDirectoryUsers

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asynclistDirectoryUsers

Runs listDirectoryUsers and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

paramoptionsListDirectoryResourceOptions

Optional request settings.

returnsListDirectoryUserResponse

Paginated results.

import com.scalekit.api.util.ListDirectoryResourceOptions;
import com.scalekit.api.util.ListDirectoryUserResponse;

ListDirectoryResourceOptions options = ListDirectoryResourceOptions.builder()
  .pageSize(50)
  .includeDetail(true)
  .build();

ListDirectoryUserResponse res = scalekitClient.directories().listDirectoryUsers("dir_123", "org_123", options);

listDirectoryGroups

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asynclistDirectoryGroups

Runs listDirectoryGroups and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

paramoptionsListDirectoryResourceOptions

Optional request settings.

returnsListDirectoryGroupResponse

Paginated results.

import com.scalekit.api.util.ListDirectoryGroupResponse;
import com.scalekit.api.util.ListDirectoryResourceOptions;

ListDirectoryResourceOptions options = ListDirectoryResourceOptions.builder()
  .pageSize(50)
  .includeDetail(true)
  .build();

ListDirectoryGroupResponse res = scalekitClient.directories().listDirectoryGroups("dir_123", "org_123", options);

enableDirectory

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asyncenableDirectory

Runs enableDirectory and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

returnsToggleDirectoryResponse

The updated resource.

scalekitClient.directories().enableDirectory("dir_123", "org_123");

disableDirectory

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asyncdisableDirectory

Runs disableDirectory and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

returnsToggleDirectoryResponse

The updated resource.

scalekitClient.directories().disableDirectory("dir_123", "org_123");

getPrimaryDirectoryByOrganizationId

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asyncgetPrimaryDirectoryByOrganizationId

Runs getPrimaryDirectoryByOrganizationId and returns the result.

paramorganizationIdString

Organization ID.

returnsDirectory

The response payload for this operation.

scalekitClient.directories().getPrimaryDirectoryByOrganizationId("org_123");

createDirectory

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asynccreateDirectory

Runs createDirectory and returns the result.

paramorganizationIdString

Organization ID.

paramdirectoryCreateDirectory

Directory.

returnsDirectory

The created resource.

import com.scalekit.grpc.scalekit.v1.directories.CreateDirectory;

CreateDirectory req = CreateDirectory.newBuilder()
  .setDisplayName("Acme SCIM Directory")
  .build();

scalekitClient.directories().createDirectory("org_123", req);

deleteDirectory

clientDirectorieshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/DirectoryClient.java

#asyncdeleteDirectory

Runs deleteDirectory and returns the result.

paramdirectoryIdString

Directory ID.

paramorganizationIdString

Organization ID.

returnsvoid

No return value

scalekitClient.directories().deleteDirectory("dir_123", "org_123");