Users
Provision and manage users and memberships
Use scalekitClient.users() to provision people, manage organization memberships, and assign roles.
Common flows: invite or create a user, attach them to an organization, update profile fields, and look up users by Scalekit ID or your external ID.
createUserAndMembership
Section titled “createUserAndMembership”#asynccreateUserAndMembership
Runs createUserAndMembership and returns the result.
Organization ID.
Request payload.
The created resource.
import com.scalekit.grpc.scalekit.v1.users.CreateUserAndMembershipRequest;
CreateUserAndMembershipRequest req = CreateUserAndMembershipRequest.newBuilder() .setEmail("user@acme.com") .build();
scalekitClient.users().createUserAndMembership("org_123", req);getUser
Section titled “getUser”#asyncgetUser
Runs getUser and returns the result.
Scalekit user ID (usr_...).
The response payload for this operation.
scalekitClient.users().getUser("user_123");listUsers
Section titled “listUsers”#asynclistUsers
Runs listUsers and returns the result.
Request payload.
Paginated results.
import com.scalekit.grpc.scalekit.v1.users.ListUsersRequest;
ListUsersRequest req = ListUsersRequest.newBuilder() .setPageSize(20) .build();
scalekitClient.users().listUsers(req);updateUser
Section titled “updateUser”#asyncupdateUser
Runs updateUser and returns the result.
Scalekit user ID (usr_...).
Request payload.
The updated resource.
import com.scalekit.grpc.scalekit.v1.users.UpdateUserRequest;
UpdateUserRequest req = UpdateUserRequest.newBuilder() .setGivenName("Jane") .build();
scalekitClient.users().updateUser("user_123", req);deleteUser
Section titled “deleteUser”#asyncdeleteUser
Runs deleteUser and returns the result.
Scalekit user ID (usr_...).
No return value
scalekitClient.users().deleteUser("user_123");createMembership
Section titled “createMembership”#asynccreateMembership
Runs createMembership and returns the result.
Organization ID.
Scalekit user ID (usr_...).
Request payload.
The created resource.
import com.scalekit.grpc.scalekit.v1.users.CreateMembershipRequest;
CreateMembershipRequest req = CreateMembershipRequest.newBuilder().build();
scalekitClient.users().createMembership("org_123", "user_123", req);deleteMembership
Section titled “deleteMembership”#asyncdeleteMembership
Runs deleteMembership and returns the result.
Organization ID.
Scalekit user ID (usr_...).
No return value
scalekitClient.users().deleteMembership("org_123", "user_123");updateMembership
Section titled “updateMembership”#asyncupdateMembership
Runs updateMembership and returns the result.
Organization ID.
Scalekit user ID (usr_...).
Request payload.
The updated resource.
import com.scalekit.grpc.scalekit.v1.users.UpdateMembershipRequest;
UpdateMembershipRequest req = UpdateMembershipRequest.newBuilder().build();
scalekitClient.users().updateMembership("org_123", "user_123", req);listOrganizationUsers
Section titled “listOrganizationUsers”#asynclistOrganizationUsers
Runs listOrganizationUsers and returns the result.
Organization ID.
Request payload.
Paginated results.
import com.scalekit.grpc.scalekit.v1.users.ListOrganizationUsersRequest;
ListOrganizationUsersRequest req = ListOrganizationUsersRequest.newBuilder() .setPageSize(20) .build();
scalekitClient.users().listOrganizationUsers("org_123", req);searchUsers
Section titled “searchUsers”#asyncsearchUsers
Runs searchUsers and returns the result.
Request payload.
Paginated results.
searchOrganizationUsers
Section titled “searchOrganizationUsers”#asyncsearchOrganizationUsers
Runs searchOrganizationUsers and returns the result.
Organization ID.
Request payload.
Paginated results.
resendInvite
Section titled “resendInvite”#asyncresendInvite
Runs resendInvite and returns the result.
Organization ID.
Scalekit user ID (usr_...).
Resend invite.
scalekitClient.users().resendInvite("org_123", "user_123");listUserRoles
Section titled “listUserRoles”#asynclistUserRoles
Runs listUserRoles and returns the result.
Organization ID.
Scalekit user ID (usr_...).
Paginated results.
listUserPermissions
Section titled “listUserPermissions”#asynclistUserPermissions
Runs listUserPermissions and returns the result.
Organization ID.
Scalekit user ID (usr_...).
Paginated results.
getUserByExternalId
Section titled “getUserByExternalId”#asyncgetUserByExternalId
Runs getUserByExternalId and returns the result.
External ID.
The response payload for this operation.
updateUserByExternalId
Section titled “updateUserByExternalId”#asyncupdateUserByExternalId
Runs updateUserByExternalId and returns the result.
External ID.
Request payload.
The updated resource.
deleteUserByExternalId
Section titled “deleteUserByExternalId”#asyncdeleteUserByExternalId
Runs deleteUserByExternalId and returns the result.
External ID.
No return value
createMembershipByExternalId
Section titled “createMembershipByExternalId”#asynccreateMembershipByExternalId
Runs createMembershipByExternalId and returns the result.
Organization ID.
External ID.
Request payload.
The created resource.
deleteMembershipByExternalId
Section titled “deleteMembershipByExternalId”#asyncdeleteMembershipByExternalId
Runs deleteMembershipByExternalId and returns the result.
Organization ID.
External ID.
No return value
updateMembershipByExternalId
Section titled “updateMembershipByExternalId”#asyncupdateMembershipByExternalId
Runs updateMembershipByExternalId and returns the result.
Organization ID.
External ID.
Request payload.
The updated resource.