TenantService

class TenantService

Methods

get_all	Get all tenants of an instance.
create	Create a new tenant.
get_all_tenant_coupons	Retrieves all visible tenant coupon for the tenant linked to the tenant.
create_tenant_coupon	Create a new coupon valid to redeem any course in a tenant, by Tenant id.
delete_tenant_coupon	Delete a coupon.
update_tenant_coupon	Update the given coupon with new values.
put_price	Update the price of the given course.
delete_price	Update the price of the given course.
get	Get a tenant by id.
patch	Update a tenant by id.
get_logo	Get the logo of a tenant.
get_lti_providers	List all LTI providers for this tenant.
get_permissions	Get the permissions of the logged in user for this tenant.
get_roles	Get all roles of this tenant with their permissions
get_settings	Get the settings for this tenant.
patch_settings	Update the settings for this tenant.
get_stats	Get the statistics of a tenant.
patch_role	Update the Permission of a given TenantRole.

get_all(*, q='', page_size=10)

Get all tenants of an instance.

Parameters:

• q (str) – Only find tenants with a name matching this search query.

• page_size (int) – The size of a single page, maximum is 100.

Returns:

All the tenants of this instance that the user is allowed to see.

Return type:

Response[Tenant]

create(multipart_data)

Create a new tenant.

Parameters:

• multipart_data (CreateTenantData) – The data that should form the body of the request. See CreateTenantData for information about the possible fields.

• self (TenantService[AuthenticatedClient]) –

Returns:

The newly created tenant.

Return type:

ExtendedTenant

get_all_tenant_coupons(*, tenant_id, page_size=20)

Retrieves all visible tenant coupon for the tenant linked to the tenant.

Parameters:

• tenant_id (str) – The tenant that defines the scopes of the coupons.

• page_size (int) – The size of a single page, maximum is 50.

• self (TenantService[AuthenticatedClient]) –

Returns:

The list of available coupons.

Return type:

Response[TenantCouponWithCode | TenantCouponWithoutCode]

create_tenant_coupon(json_body, *, tenant_id)

Create a new coupon valid to redeem any course in a tenant, by Tenant id.

Parameters:

• json_body (CouponDataParser) – The body of the request. See CouponDataParser for information about the possible fields. You can provide this data as a CouponDataParser or as a dictionary.

• tenant_id (str) – The tenant that defines the scopes of the coupons.

• self (TenantService[AuthenticatedClient]) –

Returns:

The coupon created for this tenant.

Return type:

TenantCouponWithCode | TenantCouponWithoutCode

delete_tenant_coupon(*, tenant_id, coupon_id)

Delete a coupon.

Parameters:

• tenant_id (str) – The id of the tenant price the coupon is connected to.

• coupon_id (str) – The id of the coupon you want to delete.

• self (TenantService[AuthenticatedClient]) –

Returns:

Nothing

Return type:

None

update_tenant_coupon(json_body, *, tenant_id, coupon_id)

Update the given coupon with new values.

Parameters:

• json_body (CouponDataParser) – The body of the request. See CouponDataParser for information about the possible fields. You can provide this data as a CouponDataParser or as a dictionary.

• tenant_id (str) – The tenant that defines the scopes of the coupons.

• coupon_id (str) – The id of the coupon you want to update.

• self (TenantService[AuthenticatedClient]) –

Returns:

The updated coupon

Return type:

TenantCouponWithCode | TenantCouponWithoutCode

put_price(json_body, *, tenant_id)

Update the price of the given course.

Parameters:

• json_body (PutPriceTenantData) – The body of the request. See PutPriceTenantData for information about the possible fields. You can provide this data as a PutPriceTenantData or as a dictionary.

• tenant_id (str) – The id of the tenant for which you want to update the price.

• self (TenantService[AuthenticatedClient]) –

Returns:

The created or updated price.

Return type:

TenantPrice

delete_price(*, tenant_id)

Update the price of the given course.

Parameters:

• tenant_id (str) – The id of the tenant for which you want to delete the price.

• self (TenantService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

get(*, tenant_id)

Get a tenant by id.

Parameters:

tenant_id (str) – The id of the tenant you want to retrieve.

Returns:

The tenant with the given id.

Return type:

ExtendedTenant

patch(json_body, *, tenant_id)

Update a tenant by id.

Parameters:

• json_body (PatchTenantData) – The body of the request. See PatchTenantData for information about the possible fields. You can provide this data as a PatchTenantData or as a dictionary.

• tenant_id (str) – The id of the tenant you want to update.

• self (TenantService[AuthenticatedClient]) –

Returns:

The updated tenant.

Return type:

ExtendedTenant

get_logo(*, tenant_id, dark=False)

Get the logo of a tenant.

Parameters:

• tenant_id (str) – The id of the tenant for which you want to get the logo.

• dark (bool) – If truhty the retrieved logo will be suited for the dark theme.

Returns:

The logo of the tenant.

Return type:

bytes

get_lti_providers(*, tenant_id, page_size=20)

List all LTI providers for this tenant.

Parameters:

• tenant_id (str) – The id of the tenant to get the LTI providers for.

• page_size (int) – The size of a single page, maximum is 50.

• self (TenantService[AuthenticatedClient]) –

Returns:

A list of all known LTI providers.

Return type:

Response[FinalizedLTI1p3Provider | NonFinalizedLTI1p3Provider | FinalizedLTI1p1Provider | NonFinalizedLTI1p1Provider]

get_permissions(*, tenant_id)

Get the permissions of the logged in user for this tenant.

If the user does not have an associated role within the tenant, the global permissions of the user are returned.

Parameters:

• tenant_id (str) – The tenant for which to get the permissions.

• self (TenantService[AuthenticatedClient]) –

Returns:

The courses for this tenant.

Return type:

TenantPermissions | NoPermissions

get_roles(*, tenant_id)

Get all roles of this tenant with their permissions

Parameters:

• tenant_id (str) – The tenant to get the roles for.

• self (TenantService[AuthenticatedClient]) –

Returns:

An array of roles.

Return type:

Sequence[TenantRoleAsJSONWithPerms]

get_settings(*, tenant_id, only_frontend=False)

Get the settings for this tenant.

Parameters:

• tenant_id (str) – The tenant for which to get the settings.

• only_frontend (bool) – Get only the frontend settings. When True the returned mapping will contain all frontend settings, even those that only have a global value.

Returns:

The settings for this tenant.

Return type:

AllSiteSettings

patch_settings(json_body, *, tenant_id)

Update the settings for this tenant.

Parameters:

• json_body (PatchSettingsTenantData) – The body of the request. See PatchSettingsTenantData for information about the possible fields. You can provide this data as a PatchSettingsTenantData or as a dictionary.

• tenant_id (str) – The tenant to update the settings for.

• self (TenantService[AuthenticatedClient]) –

Returns:

The updated tenant settings.

Return type:

AllSiteSettings

get_stats(*, tenant_id)

Get the statistics of a tenant.

Parameters:

• tenant_id (str) – The id of the tenant for which you want to get the statistics.

• self (TenantService[AuthenticatedClient]) –

Returns:

The statistics of the specified tenant.

Return type:

TenantStatistics

patch_role(json_body, *, tenant_id, role_id)

Update the Permission of a given TenantRole.

Parameters:

• json_body (PatchRoleTenantData) – The body of the request. See PatchRoleTenantData for information about the possible fields. You can provide this data as a PatchRoleTenantData or as a dictionary.

• tenant_id (str) – The tenant to patch the role for.

• role_id (int) – The id of the tenant role.

• self (TenantService[AuthenticatedClient]) –

Returns:

An empty response with return code 204.

Return type:

None