Organizations

Use scalekitClient.organizations() to create and manage customer tenants (organizations) in your Scalekit application.

Start here when onboarding a new customer: create an organization, set external IDs and branding, then add users and SSO for that org.

create

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asynccreate

Runs create and returns the result.

paramorganizationCreateOrganization

Fields to update.

returnsOrganization

The created resource.

// displayName: Display name
// metadata: Custom key-value metadata
import com.scalekit.grpc.scalekit.v1.organizations.CreateOrganization;
import com.scalekit.grpc.scalekit.v1.organizations.Organization;

CreateOrganization req = CreateOrganization.newBuilder()
  .setName("Acme Corporation")
  .build();

Organization org = scalekitClient.organizations().create(req);

getById

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncgetById

Runs getById and returns the result.

paramidString

Resource ID.

returnsOrganization

The response payload for this operation.

scalekitClient.organizations().getById("org_123");

getByExternalId

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncgetByExternalId

Runs getByExternalId and returns the result.

paramexternalIdString

External ID.

returnsOrganization

The response payload for this operation.

scalekitClient.organizations().getByExternalId("customer_123");

updateById

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncupdateById

Runs updateById and returns the result.

paramidString

Resource ID.

paramorganizationUpdateOrganization

Fields to update.

returnsOrganization

The updated resource.

// displayName: Display name
// metadata: Custom key-value metadata
import com.scalekit.grpc.scalekit.v1.organizations.UpdateOrganization;

UpdateOrganization req = UpdateOrganization.newBuilder()
  .setName("Acme Corp (Updated)")
  .build();

scalekitClient.organizations().updateById("org_123", req);

updateByExternalId

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncupdateByExternalId

Runs updateByExternalId and returns the result.

paramexternalIdString

External ID.

paramorganizationUpdateOrganization

Fields to update.

returnsOrganization

The updated resource.

// displayName: Display name
// metadata: Custom key-value metadata
import com.scalekit.grpc.scalekit.v1.organizations.UpdateOrganization;

UpdateOrganization req = UpdateOrganization.newBuilder()
  .setName("Acme Corp (Updated)")
  .build();

scalekitClient.organizations().updateByExternalId("customer_123", req);

deleteById

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncdeleteById

Runs deleteById and returns the result.

paramidString

Resource ID.

returnsvoid

No return value

scalekitClient.organizations().deleteById("org_123");

deleteByExternalId

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncdeleteByExternalId

Runs deleteByExternalId and returns the result.

paramexternalIdString

External ID.

returnsvoid

No return value

scalekitClient.organizations().deleteByExternalId("customer_123");

listOrganizations

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asynclistOrganizations

Runs listOrganizations and returns the result.

parampageSizeint

Page size.

parampageTokenString

Page token.

returnsListOrganizationsResponse

Paginated organizations.

scalekitClient.organizations().listOrganizations(20, "");

generatePortalLink

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncgeneratePortalLink

Runs generatePortalLink and returns the result.

paramorganizationIdString

Organization ID.

paramfeaturesList(Feature)

Features.

returnsLink

Authorization link.

import java.util.Arrays;
import com.scalekit.grpc.scalekit.v1.organizations.Feature;

scalekitClient.organizations().generatePortalLink(
  "org_123",
  Arrays.asList(Feature.FEATURE_USERS, Feature.FEATURE_CONNECTIONS)
);

updateOrganizationSettings

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncupdateOrganizationSettings

Runs updateOrganizationSettings and returns the result.

paramorganizationIdString

Organization ID.

paramsettingsList(OrganizationSettingsFeature)

Settings.

returnsOrganization

The updated resource.

import java.util.Collections;
import com.scalekit.grpc.scalekit.v1.organizations.OrganizationSettingsFeature;

scalekitClient.organizations().updateOrganizationSettings(
  "org_123",
  Collections.emptyList()
);

upsertUserManagementSettings

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncupsertUserManagementSettings

Runs upsertUserManagementSettings and returns the result.

paramorganizationIdString

Organization ID.

paramsettingsOrganizationUserManagementSettings

Settings.

returnsOrganizationUserManagementSettings

Organization user management settings.

import com.scalekit.grpc.scalekit.v1.organizations.OrganizationUserManagementSettings;

OrganizationUserManagementSettings settings =
  OrganizationUserManagementSettings.newBuilder().build();

scalekitClient.organizations().upsertUserManagementSettings("org_123", settings);

getOrganizationSessionPolicy

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncgetOrganizationSessionPolicy

Runs getOrganizationSessionPolicy and returns the result.

paramorganizationIdString

Organization ID.

returnsOrganizationSessionPolicySettings

The response payload for this operation.

updateOrganizationSessionPolicy

clientOrganizationshttps://github.com/scalekit-inc/scalekit-sdk-java/blob/main/src/main/java/com/scalekit/api/OrganizationClient.java

#asyncupdateOrganizationSessionPolicy

Runs updateOrganizationSessionPolicy and returns the result.

paramorganizationIdString

Organization ID.

parampolicyOrganizationSessionPolicySettings

Policy.

returnsOrganizationSessionPolicySettings

The updated resource.