organizations_api module

OrganizationsApi

class edgeimpulse_api.api.organizations_api.OrganizationsApi(
		api_client=None
)

Parameters

• api_client=None

Methods

add_organization_api_key

edgeimpulse_api.api.organizations_api.add_organization_api_key(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

Add API key

Add an API key.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

add_organization_member

edgeimpulse_api.api.organizations_api.add_organization_member(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Add member

Add a member to an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

delete_organization

edgeimpulse_api.api.organizations_api.delete_organization(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove organization

Remove the current organization, and all data associated with it. This is irrevocable!

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_organization_data_export

edgeimpulse_api.api.organizations_api.download_organization_data_export(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> None

Download organization data export

Download a data export for an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]

• **kwargs

Return

None

get_organization_data_export

edgeimpulse_api.api.organizations_api.get_organization_data_export(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

Get organization data export

Get a data export for an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

get_organization_data_exports

edgeimpulse_api.api.organizations_api.get_organization_data_exports(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

Get all organization data exports

Get all data exports for an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

get_organization_info

edgeimpulse_api.api.organizations_api.get_organization_info(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.organization_info_response.OrganizationInfoResponse

Organization information

List all information about this organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.organization_info_response.OrganizationInfoResponse

get_organization_metrics

edgeimpulse_api.api.organizations_api.get_organization_metrics(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		exclude_edge_impulse_users: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude Edge Impulse users when counting enterprise entitlements usage', extra={})] = None,
		project_visibility: Annotated[edgeimpulse_api.models.project_visibility.ProjectVisibility | None, FieldInfo(default=PydanticUndefined, description='What project visibility type to include when counting enterprise entitlements usage', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.organization_metrics_response.OrganizationMetricsResponse

Organization metrics

Get general metrics for this organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• exclude_edge_impulse_users: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude Edge Impulse users when counting enterprise entitlements usage', extra={})] = None

• project_visibility: Annotated[edgeimpulse_api.models.project_visibility.ProjectVisibility | None, FieldInfo(default=PydanticUndefined, description='What project visibility type to include when counting enterprise entitlements usage', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.organization_metrics_response.OrganizationMetricsResponse

invite_organization_member

edgeimpulse_api.api.organizations_api.invite_organization_member(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		invite_organization_member_request: edgeimpulse_api.models.invite_organization_member_request.InviteOrganizationMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Invite member

Invite a member to an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• invite_organization_member_request: edgeimpulse_api.models.invite_organization_member_request.InviteOrganizationMemberRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

list_organization_api_keys

edgeimpulse_api.api.organizations_api.list_organization_api_keys(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_organization_api_keys_response.ListOrganizationApiKeysResponse

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_organization_api_keys_response.ListOrganizationApiKeysResponse

list_organization_projects

edgeimpulse_api.api.organizations_api.list_organization_projects(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_projects_response.ListProjectsResponse

Get projects

Retrieve all projects for the organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_projects_response.ListProjectsResponse

list_organizations

edgeimpulse_api.api.organizations_api.list_organizations(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse

List active organizations

Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse

remove_organization_member

edgeimpulse_api.api.organizations_api.remove_organization_member(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		remove_member_request: edgeimpulse_api.models.remove_member_request.RemoveMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove member

Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• remove_member_request: edgeimpulse_api.models.remove_member_request.RemoveMemberRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

request_enterprise_hr_block_license

edgeimpulse_api.api.organizations_api.request_enterprise_hr_block_license(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Request HR block license

Request a license required for the deployment of an impulse containing the Edge Impulse HR block.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

request_enterprise_limits_increase

edgeimpulse_api.api.organizations_api.request_enterprise_limits_increase(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		enterprise_limits_increase_request: edgeimpulse_api.models.enterprise_limits_increase_request.EnterpriseLimitsIncreaseRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Request organization limits increase

Request an increase in the limits for this organization. Available limits are: users, projects, compute, storage.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• enterprise_limits_increase_request: edgeimpulse_api.models.enterprise_limits_increase_request.EnterpriseLimitsIncreaseRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

request_enterprise_trial_extension

edgeimpulse_api.api.organizations_api.request_enterprise_trial_extension(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Request trial extension

Request an extension for an enterprise trial.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

resend_organization_member_invite

edgeimpulse_api.api.organizations_api.resend_organization_member_invite(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Resend invitation

Resend an invitation to a member in an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

revoke_organization_api_key

edgeimpulse_api.api.organizations_api.revoke_organization_api_key(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		api_key_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Revoke API key

Revoke an API key.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• api_key_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_organization_member_datasets

edgeimpulse_api.api.organizations_api.set_organization_member_datasets(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		set_member_datasets_request: edgeimpulse_api.models.set_member_datasets_request.SetMemberDatasetsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set member datasets

Set the datasets a guest member has access to in an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]

• set_member_datasets_request: edgeimpulse_api.models.set_member_datasets_request.SetMemberDatasetsRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_organization_member_role

edgeimpulse_api.api.organizations_api.set_organization_member_role(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		set_member_role_request: edgeimpulse_api.models.set_member_role_request.SetMemberRoleRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set member role

Change the role of a member in an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• member_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})]

• set_member_role_request: edgeimpulse_api.models.set_member_role_request.SetMemberRoleRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

test_organization_admin

edgeimpulse_api.api.organizations_api.test_organization_admin(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Admin endpoint

Test endpoint that can only be reached with admin rights.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_organization

edgeimpulse_api.api.organizations_api.update_organization(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_organization_request: edgeimpulse_api.models.update_organization_request.UpdateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update organization

Update organization properties such as name and logo.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• update_organization_request: edgeimpulse_api.models.update_organization_request.UpdateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

upload_organization_header

edgeimpulse_api.api.organizations_api.upload_organization_header(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: pydantic.types.StrictStr | None = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

Upload organization header image

Uploads and updates the organization header image

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• image: pydantic.types.StrictStr | None = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

upload_organization_logo

edgeimpulse_api.api.organizations_api.upload_organization_logo(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: pydantic.types.StrictStr | None = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

Upload organization logo

Uploads and updates the organization logo

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• image: pydantic.types.StrictStr | None = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

upload_organization_readme_image

edgeimpulse_api.api.organizations_api.upload_organization_readme_image(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: pydantic.types.StrictStr,
		**kwargs
) ‑> edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse

Upload image for readme

Uploads an image to the user CDN and returns the path.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• image: pydantic.types.StrictStr

• **kwargs

Return

edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse

whitelabel_admin_add_development_board

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_development_board(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		development_board_request: edgeimpulse_api.models.development_board_request.DevelopmentBoardRequest,
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

White Label Admin - Add a development board to a whitelabel

White label admin only API to add a development board.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• development_board_request: edgeimpulse_api.models.development_board_request.DevelopmentBoardRequest

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

whitelabel_admin_add_organization_api_key

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_organization_api_key(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_add_organization_api_key_request: edgeimpulse_api.models.admin_add_organization_api_key_request.AdminAddOrganizationApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

White Label Admin - Add organization API key

White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_add_organization_api_key_request: edgeimpulse_api.models.admin_add_organization_api_key_request.AdminAddOrganizationApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

whitelabel_admin_add_project_api_key

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_project_api_key(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		admin_add_project_api_key_request: edgeimpulse_api.models.admin_add_project_api_key_request.AdminAddProjectApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

White Label Admin - Add Project API key

White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• admin_add_project_api_key_request: edgeimpulse_api.models.admin_add_project_api_key_request.AdminAddProjectApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

whitelabel_admin_add_user_to_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_user_to_organization(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_add_organization_user_request: edgeimpulse_api.models.admin_add_organization_user_request.AdminAddOrganizationUserRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add user to an organization

White label admin only API to add a user to an organization. If no user is provided, the current user is used.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_add_organization_user_request: edgeimpulse_api.models.admin_add_organization_user_request.AdminAddOrganizationUserRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_add_user_to_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_user_to_project(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		admin_add_project_user_request: edgeimpulse_api.models.admin_add_project_user_request.AdminAddProjectUserRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add user to a project

White label admin only API to add a user to a project. If no user is provided, the current user is used.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• admin_add_project_user_request: edgeimpulse_api.models.admin_add_project_user_request.AdminAddProjectUserRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_create_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		whitelabel_admin_create_organization_request: edgeimpulse_api.models.whitelabel_admin_create_organization_request.WhitelabelAdminCreateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

White Label Admin - Create new organization within white label context

Create a new organization. This is an API only available to white label admins

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• whitelabel_admin_create_organization_request: edgeimpulse_api.models.whitelabel_admin_create_organization_request.WhitelabelAdminCreateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

whitelabel_admin_create_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_export(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_create_organization_data_export_request: edgeimpulse_api.models.admin_create_organization_data_export_request.AdminCreateOrganizationDataExportRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_create_organization_data_export_request: edgeimpulse_api.models.admin_create_organization_data_export_request.AdminCreateOrganizationDataExportRequest

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_create_organization_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_project(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse

White Label Admin - Create a new organization project

White label admin only API to create a new project for an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.create_project_response.CreateProjectResponse

whitelabel_admin_create_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_usage_report(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		start_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})],
		end_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• start_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]

• end_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_create_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_project(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse

White Label Admin - Create a new project within white label context.

Create a new free tier project. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.create_project_response.CreateProjectResponse

whitelabel_admin_delete_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Delete an organization

White label admin only API to delete an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_delete_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization_export(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete organization data export

Delete a data export for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization_usage_report(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete usage report

Delete a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_project(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Delete a project

White label admin only API to delete a project.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_delete_user

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_user(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		user_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete a user

White label admin only API to delete a user.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• user_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_download_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_download_organization_usage_report(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})],
		**kwargs
) ‑> None

White Label Admin - Download usage report

Download a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})]

• **kwargs

Return

None

whitelabel_admin_get_info

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_info(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse

White Label Admin - Get white label information

White label admin only API to get the white label information.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse

whitelabel_admin_get_metrics

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_metrics(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_metrics_response.AdminGetMetricsResponse

White Label Admin - Get global white label metrics

White label admin only API to get global metrics.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.admin_get_metrics_response.AdminGetMetricsResponse

whitelabel_admin_get_organization_compute_time_usage

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_compute_time_usage(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		start_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})],
		end_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organization_compute_time_usage_response.AdminGetOrganizationComputeTimeUsageResponse

White Label Admin - Get organization compute time usage

Get compute time usage for an organization over a period of time. This is an API only available to white label admins

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• start_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]

• end_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]

• **kwargs

Return

edgeimpulse_api.models.admin_get_organization_compute_time_usage_response.AdminGetOrganizationComputeTimeUsageResponse

whitelabel_admin_get_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_export(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• export_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

whitelabel_admin_get_organization_exports

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_exports(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

White Label Admin - Get all organization data exports

Get all data exports for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

whitelabel_admin_get_organization_info

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_info(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		include_deleted: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_organization_info_response.AdminOrganizationInfoResponse

White Label Admin - Get organization information

White label admin only API to list all information about an organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• include_deleted: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_organization_info_response.AdminOrganizationInfoResponse

whitelabel_admin_get_organization_jobs

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_jobs(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

White Label Admin - Get organization jobs

White label admin only API to get the list of all jobs for a organization.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.list_jobs_response.ListJobsResponse

whitelabel_admin_get_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_usage_report(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_report_response.AdminGetReportResponse

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• report_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Report ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.admin_get_report_response.AdminGetReportResponse

whitelabel_admin_get_organization_usage_reports

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_usage_reports(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_reports_response.AdminGetReportsResponse

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• inner_organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_get_reports_response.AdminGetReportsResponse

whitelabel_admin_get_organizations

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organizations(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		active: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None,
		include_deleted: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None,
		sort: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None,
		filters: pydantic.types.StrictStr | None = None,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organizations_response.AdminGetOrganizationsResponse

White Label Admin - Get all organizations within a white label

White label admin only API to get the list of all organizations.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• active: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None

• include_deleted: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None

• sort: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None

• filters: pydantic.types.StrictStr | None = None

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• search: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_get_organizations_response.AdminGetOrganizationsResponse

whitelabel_admin_get_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_project(
		self,
		organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_project_info_response.AdminProjectInfoResponse

White Label Admin - Get a white label project

White label admin only API to get project information.

Parameters

• self

• organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.admin_project_info_response.AdminProjectInfoResponse

whitelabel_admin_get_project_jobs

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_project_jobs(