Users
Provision and manage users and memberships
Use scalekit_client.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.
list_users
Section titled “list_users”#list_users
Method to list all users in environment
Optional. Page size for pagination
Optional. Page token for pagination
List Users Response
response = scalekit_client.users.list_users( page_size=50, page_token='next_page_token')
for user in response[0].users: print(f"User: {user.email}")list_organization_users
Section titled “list_organization_users”#list_organization_users
Method to list users for given organization id
Organization id to list users for
Optional. Page size for pagination
Optional. Page token for pagination
List Organization Users Response
response = scalekit_client.users.list_organization_users( 'org_123456', page_size=50)
for user in response[0].users: print(f"User: {user.email}")get_user
Section titled “get_user”#get_user
Method to get user by ID
User id to get user details
Get User Response
response = scalekit_client.users.get_user('usr_123456')user = response[0].userprint(f"User: {user.email}")get_user_by_external_id
Section titled “get_user_by_external_id”#get_user_by_external_id
Method to get user by external ID
External id to get user details
Get User Response
response = scalekit_client.users.get_user_by_external_id('external_123')user = response[0].usercreate_user_and_membership
Section titled “create_user_and_membership”#create_user_and_membership
Method to create a new user and add them to an organization
Organization id to create user for
CreateUser object with expected values for user creation
Optional. Whether to send invitation email to the user
Create User And Membership Response
from scalekit.v1.users.users_pb2 import CreateUser
user = CreateUser()user.email = "john.doe@example.com"user.given_name = "John"user.family_name = "Doe"
response = scalekit_client.users.create_user_and_membership( 'org_123456', user, send_invitation_email=True)update_user
Section titled “update_user”#update_user
Method to update an existing user by ID
User id to update
UpdateUser object with expected values for user update
Update User Response
from scalekit.v1.users.users_pb2 import UpdateUser
user = UpdateUser()user.given_name = "John"
response = scalekit_client.users.update_user('usr_123456', user)delete_user
Section titled “delete_user”#delete_user
Method to delete user by ID
User id to be deleted
Empty on success.
scalekit_client.users.delete_user('usr_123456')create_membership
Section titled “create_membership”#create_membership
Method to create a membership for a user by user ID
Organization id
User id
CreateMembership object
Optional. Whether to send invitation email to the user
Create Membership Response
from scalekit.v1.users.users_pb2 import CreateMembership
membership = CreateMembership()
response = scalekit_client.users.create_membership( 'org_123456', 'usr_123456', membership, send_invitation_email=True)update_membership
Section titled “update_membership”#update_membership
Method to update a membership for a user by user ID
Organization id
User id
UpdateMembership object
Update Membership Response
from scalekit.v1.users.users_pb2 import UpdateMembership
membership = UpdateMembership()
response = scalekit_client.users.update_membership( 'org_123456', 'usr_123456', membership)delete_membership
Section titled “delete_membership”#delete_membership
Method to delete a membership for a user by user ID
Organization id
User id
Empty on success.
scalekit_client.users.delete_membership('org_123456', 'usr_123456')resend_invite
Section titled “resend_invite”#resend_invite
Method to resend an invitation email to a user who has a pending invitation
Organization id containing the pending invitation
User id who has a pending invitation
Resend Invite Response
response = scalekit_client.users.resend_invite('org_123456', 'usr_123456')update_user_by_external_id
Section titled “update_user_by_external_id”#update_user_by_external_id
Method to update an existing user by external ID
External id to update
UpdateUser object with expected values for user update
Update User Response
delete_user_by_external_id
Section titled “delete_user_by_external_id”#delete_user_by_external_id
Method to delete user by external ID
External id to be deleted
Empty on success.
create_membership_by_external_id
Section titled “create_membership_by_external_id”#create_membership_by_external_id
Method to create a membership for a user by external ID
Organization id
External id
CreateMembership object
Optional. Whether to send invitation email to the user
Create Membership Response
update_membership_by_external_id
Section titled “update_membership_by_external_id”#update_membership_by_external_id
Method to update a membership for a user by external ID
Organization id
External id
UpdateMembership object
Update Membership Response
delete_membership_by_external_id
Section titled “delete_membership_by_external_id”#delete_membership_by_external_id
Method to delete a membership for a user by external ID
Organization id
External id
Empty on success.
list_user_roles
Section titled “list_user_roles”#list_user_roles
Method to list all roles assigned to a user in an organization
Organization id containing the user
User id to list roles for
List User Roles Response
list_user_permissions
Section titled “list_user_permissions”#list_user_permissions
Method to list all permissions granted to a user in an organization
Organization id containing the user
User id to list permissions for
List User Permissions Response