Roles
Define and assign organization roles
Use scalekit_client.roles to define organization roles and list role assignments.
Create roles and permissions for authorization after you have organizations and users.
list_roles
Section titled “list_roles”#asynclist_roles
Method to list all roles
List Roles Response
response = scalekit_client.roles.list_roles()
for role in response[0].roles: print(f"Role: {role.name}")get_role
Section titled “get_role”#asyncget_role
Method to get role by name
Role name to get role details
Get Role Response
response = scalekit_client.roles.get_role('admin')role = response[0].rolecreate_role
Section titled “create_role”#asynccreate_role
Method to create a new role
CreateRole object with expected values for role creation
Create Role Response
from scalekit.v1.roles.roles_pb2 import CreateRole
role = CreateRole()role.name = "editor"role.display_name = "Editor"
response = scalekit_client.roles.create_role(role)update_role
Section titled “update_role”#asyncupdate_role
Method to update an existing role by name
Role name to update
UpdateRole object with expected values for role update
Update Role Response
from scalekit.v1.roles.roles_pb2 import UpdateRole
role = UpdateRole()role.display_name = "Senior Editor"
response = scalekit_client.roles.update_role('editor', role)delete_role
Section titled “delete_role”#asyncdelete_role
Method to delete role by name
Role name to be deleted
Replacement role for users.
Empty on success.
scalekit_client.roles.delete_role('editor', reassign_role_name='viewer')get_role_users_count
Section titled “get_role_users_count”#asyncget_role_users_count
Method to get the count of users associated with a role
Role name to get user count for
Get Role Users Count Response
response = scalekit_client.roles.get_role_users_count('admin')print(f"User count: {response[0].count}")list_organization_roles
Section titled “list_organization_roles”#asynclist_organization_roles
Method to list all organization roles
Organization ID
List Organization Roles Response
response = scalekit_client.roles.list_organization_roles('org_123456')
for role in response[0].roles: print(f"Role: {role.name}")create_organization_role
Section titled “create_organization_role”#asynccreate_organization_role
Method to create a new organization role
Organization ID
Role create payload.
Create Organization Role Response
from scalekit.v1.roles.roles_pb2 import CreateOrganizationRole
role = CreateOrganizationRole()role.name = "org_admin"role.display_name = "Organization Admin"
response = scalekit_client.roles.create_organization_role('org_123456', role)get_organization_role
Section titled “get_organization_role”#asyncget_organization_role
Method to get organization role by name
Organization ID
Role name to get role details
Get Organization Role Response
response = scalekit_client.roles.get_organization_role('org_123456', 'org_admin')role = response[0].roleupdate_organization_role
Section titled “update_organization_role”#asyncupdate_organization_role
Method to update an existing organization role by name
Organization ID
Role name to update
Role update payload.
Update Organization Role Response
from scalekit.v1.roles.roles_pb2 import UpdateRole
role = UpdateRole()role.display_name = "Organization Administrator"
response = scalekit_client.roles.update_organization_role( 'org_123456', 'org_admin', role)delete_organization_role
Section titled “delete_organization_role”#asyncdelete_organization_role
Method to delete organization role by name
Organization ID
Role name to be deleted
Replacement role for users.
Empty on success.
scalekit_client.roles.delete_organization_role( 'org_123456', 'org_admin', reassign_role_name='member')delete_role_base
Section titled “delete_role_base”#asyncdelete_role_base
Method to delete the base inheritance relationship for an environment-level role
Role name to remove base relationship for
Empty on success.
get_organization_role_users_count
Section titled “get_organization_role_users_count”#asyncget_organization_role_users_count
Method to get the count of users associated with an organization role
Organization ID
Role name to get user count for
Get Organization Role Users Count Response
update_default_organization_roles
Section titled “update_default_organization_roles”#asyncupdate_default_organization_roles
Method to update default organization roles
Organization ID
UpdateDefaultOrganizationRoles object with default role.
Update Default Organization Roles Response
delete_organization_role_base
Section titled “delete_organization_role_base”#asyncdelete_organization_role_base
Method to delete organization role base relationship by name
Organization ID
Role name to remove base relationship for
Empty on success.
update_default_roles
Section titled “update_default_roles”#asyncupdate_default_roles
Method to update default environment-level roles
Optional. Name of the role to set as default creator role
Optional. Name of the role to set as default member role
Update Default Roles Response
list_dependent_roles
Section titled “list_dependent_roles”#asynclist_dependent_roles
Method to list roles that directly extend (depend on) the specified base role
Name of the base role
List Dependent Roles Response