Organizations

Use scalekit_client.organization 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.

list_organizations

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asynclist_organizations

Method to list organizations

parampage_sizeOptional[int]

Results per page.

parampage_tokenOptional[str]

Optional. page token for org list fetch

returnsListOrganizationsResponse

list of organizations

response = scalekit_client.organization.list_organizations(
    page_size=50,
    page_token='next_page_token'
)

for org in response[0].organizations:
    print(f"Organization: {org.display_name}")

create_organization

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asynccreate_organization

Method to create organization based on given data

paramorganizationCreateOrganization

Create Organization obj with details for org creation

returnsCreateOrganizationResponse

Create Organization Response

from scalekit.v1.organizations.organizations_pb2 import CreateOrganization

org = CreateOrganization()
org.display_name = "Acme Corp"
org.external_id = "acme_123"

response = scalekit_client.organization.create_organization(org)
print(f"Created organization: {response[0].organization.id}")

get_organization

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncget_organization

Method to get organization based on given org id

paramorganization_idstr

Organization id

returnsGetOrganizationResponse

Get Organization Response

response = scalekit_client.organization.get_organization('org_123456')
organization = response[0].organization
print(f"Organization: {organization.display_name}")

get_organization_by_external_id

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncget_organization_by_external_id

Method to get organization based on given org id

paramexternal_idstr

External id to fetch org details

returnsNone

Get Organization Response

response = scalekit_client.organization.get_organization_by_external_id('acme_123')
organization = response[0].organization

update_organization

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncupdate_organization

Method to update organization based on given data

paramorganization_idstr

Organization id to update

paramorganizationUpdateOrganization

params for update organization operation

returnsUpdateOrganizationResponse

Update Organization Response

from scalekit.v1.organizations.organizations_pb2 import UpdateOrganization

org = UpdateOrganization()
org.display_name = "Acme Corporation"

response = scalekit_client.organization.update_organization('org_123456', org)

delete_organization

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncdelete_organization

Method to delete organization based on given org id

paramorganization_idstr

Organization id

returnsNone

Empty on success.

scalekit_client.organization.delete_organization('org_123456')

generate_portal_link

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncgenerate_portal_link

Method to generate customer portal link

paramorganization_idstr

Organization id to fetch portal link for

paramfeatures[Feature]

Optional. Feature list to generate portal link for

returnsGeneratePortalLinkResponse

Authorization link.

portal_link = scalekit_client.organization.generate_portal_link('org_123456')
print(f"Portal Link: {portal_link}")

update_organization_by_external_id

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncupdate_organization_by_external_id

Method to update organization based on external id

paramexternal_idstr

External id to update org

paramorganizationUpdateOrganization

params for update organization operation

returnsUpdateOrganizationResponse

Update Organization Response

update_organization_settings

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncupdate_organization_settings

Method to update organization settings

paramorganization_idstr

Organization id for org update

paramsettingsList[Dict[str, bool]]

Organization settings

returnsNone

The updated resource.

upsert_user_management_settings

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncupsert_user_management_settings

Upsert organization user management settings like maximum allowed users.

paramorganization_idstr

Organization id for update

parammax_allowed_usersOptional[int]

Optional. Maximum allowed users (None to clear)

returnsNone

None.

get_organization_session_policy

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncget_organization_session_policy

Get the session policy for an organization.

paramorganization_idstr

Organization id

returnsGetOrganizationSessionPolicyResponse

The response payload for this operation.

update_organization_session_policy

clientOrganizationhttps://github.com/scalekit-inc/scalekit-sdk-python/blob/main/scalekit/organization.py

#asyncupdate_organization_session_policy

Runs update_organization_session_policy and returns the result.

paramorganization_idstr

Organization ID.

parampolicy_sourceSessionPolicyType

Policy source.

paramabsolute_session_timeoutOptional[int]

Absolute session timeout.

paramabsolute_session_timeout_unitOptional[TimeUnit]

Timeout unit.

paramidle_session_timeout_enabledOptional[bool]

Idle session timeout enabled.

paramidle_session_timeoutOptional[int]

Idle session timeout.

paramidle_session_timeout_unitOptional[TimeUnit]

Timeout unit.

returnsUpdateOrganizationSessionPolicyResponse

The updated resource.