admin_api module#

class edgeimpulse_api.api.admin_api.AdminApi(api_client=None)[source]#

Bases: object

admin_add_disallowed_email_domain(

admin_add_disallowed_email_domain_request: AdminAddDisallowedEmailDomainRequest,

**kwargs,

) → GenericApiResponse[source]#

Add a disallowed email domain

Admin-only API to add an email domain to the list of disallowed email domains.

Parameters:

admin_add_disallowed_email_domain_request (AdminAddDisallowedEmailDomainRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_add_or_update_sso_domain_id_ps(

domain_name: StrictStr[StrictStr],

admin_add_or_update_sso_domain_id_ps_request: AdminAddOrUpdateSSODomainIdPsRequest,

**kwargs,

) → GenericApiResponse[source]#

Add or update SSO settings for a domain

Admin-only API to set the list of identity provider for a given domain.

Parameters:

domain_name (str) – Email domain name (required)
admin_add_or_update_sso_domain_id_ps_request (AdminAddOrUpdateSSODomainIdPsRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_add_user_to_organization(

organization_id: StrictInt[StrictInt],

admin_add_organization_user_request: AdminAddOrganizationUserRequest | None = None,

**kwargs,

) → GenericApiResponse[source]#

Add user to an organization

Admin-only API to add a user to an organization. If no user is provided, the current user is used.

Parameters:

organization_id (int) – Organization ID (required)
admin_add_organization_user_request (AdminAddOrganizationUserRequest) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_add_user_to_project(

project_id: StrictInt[StrictInt],

admin_add_project_user_request: AdminAddProjectUserRequest | None = None,

**kwargs,

) → GenericApiResponse[source]#

Add user to a project

Admin-only API to add a user to a project. If no user is provided, the current user is used.

Parameters:

project_id (int) – Project ID (required)
admin_add_project_user_request (AdminAddProjectUserRequest) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_create_organization(

admin_create_organization_request: AdminCreateOrganizationRequest,

**kwargs,

) → CreateOrganizationResponse[source]#

Create a new organization

Admin-only API to create a new organization.

Parameters:

admin_create_organization_request (AdminCreateOrganizationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateOrganizationResponse

admin_create_organization_data_export(

organization_id: StrictInt[StrictInt],

admin_create_organization_data_export_request: AdminCreateOrganizationDataExportRequest,

**kwargs,

) → StartJobResponse[source]#

Create a new organization data export

Admin-only API to 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.

Parameters:

organization_id (int) – Organization ID (required)
admin_create_organization_data_export_request (AdminCreateOrganizationDataExportRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

admin_create_organization_project(

organization_id: StrictInt[StrictInt],

admin_create_project_request: AdminCreateProjectRequest,

**kwargs,

) → CreateProjectResponse[source]#

Create a new organization project

Admin-only API to create a new project for an organization.

Parameters:

organization_id (int) – Organization ID (required)
admin_create_project_request (AdminCreateProjectRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateProjectResponse

admin_create_organization_usage_report(

organization_id: StrictInt[StrictInt],

start_date: datetime[datetime],

end_date: datetime[datetime],

**kwargs,

) → StartJobResponse[source]#

Creates a new usage report

Admin-only API to 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.

Parameters:

organization_id (int) – Organization ID (required)
start_date (datetime) – Start date (required)
end_date (datetime) – End date (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

admin_create_project(

admin_create_project_request: AdminCreateProjectRequest,

**kwargs,

) → CreateProjectResponse[source]#

Create a new project

Admin-only API to create a new free tier project.

Parameters:

admin_create_project_request (AdminCreateProjectRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateProjectResponse

admin_create_user_trial(

user_id: StrictInt[StrictInt],

start_enterprise_trial_request: StartEnterpriseTrialRequest,

**kwargs,

) → EntityCreatedResponse[source]#

Create user enterprise trial

Admin-only API to create an enterprise trial for a user.

Parameters:

user_id (int) – User ID (required)
start_enterprise_trial_request (StartEnterpriseTrialRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

EntityCreatedResponse

admin_delete_disallowed_email_domain(

domain_name: StrictStr[StrictStr],

**kwargs,

) → GenericApiResponse[source]#

Delete disallowed email domain

Admin-only API to delete an email domain from the list of disallowed email domains.

Parameters:

domain_name (str) – Email domain name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_organization(

organization_id: StrictInt[StrictInt],

full_deletion: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → GenericApiResponse[source]#

Delete an organization

Admin-only API to delete an organization. If fullDeletion is set, it deletes the organization’s identifiable information and files. Otherwise, it soft deletes the organization by setting its delete_date value.

Parameters:

organization_id (int) – Organization ID (required)
full_deletion (bool) – Set to true for full deletion
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_organization_data_export(

organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete organization data export

Admin-only API to delete a data export for an organization.

Parameters:

organization_id (int) – Organization ID (required)
export_id (int) – Export ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_organization_usage_report(

organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete usage report

Admin-only API to delete a usage report for an organization.

Parameters:

organization_id (int) – Organization ID (required)
usage_report_id (int) – Usage report ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_project(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete a project

Admin-only API to delete a project.

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_sso_domain_id_ps(

domain_name: StrictStr[StrictStr],

**kwargs,

) → GenericApiResponse[source]#

Delete SSO settings for a domain

Admin-only API to delete the list of identity providers for a given domain.

Parameters:

domain_name (str) – Email domain name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_delete_user(

user_id: StrictInt[StrictInt],

full_deletion: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → StartJobResponse[source]#

Delete a user

Admin-only API to delete a user. If fullDeletion is set, it deletes the user’s identifiable information and files. Otherwise, it soft deletes the user by setting it’s delete_date value.

Parameters:

user_id (int) – User ID (required)
full_deletion (bool) – Set to true for full deletion
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

admin_delete_user_trial(

user_id: StrictInt[StrictInt],

enterprise_trial_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete user enterprise trial

Admin-only API to delete an enterprise trial for a user.

Parameters:

user_id (int) – User ID (required)
enterprise_trial_id (int) – Enterprise trial ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_disable_feature(

feature_id: Feature[Feature],

**kwargs,

) → GenericApiResponse[source]#

Set a feature flag OFF

Admin-only API to delete a feature flag. Deleting a feature flag essentially disables the feature for all users.

Parameters:

feature_id (Feature) – Feature ID. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_download_organization_usage_report(

organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → None[source]#

Download usage report

Admin-only API to download a usage report for an organization.

Parameters:

organization_id (int) – Organization ID (required)
usage_report_id (int) – Usage report ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

admin_enable_feature(

feature_id: Feature[Feature],

**kwargs,

) → GenericApiResponse[source]#

Set a feature flag ON

Admin-only API to set a feature flag ON. Setting a feature flag ON essentially enables the feature for all users.

Parameters:

feature_id (Feature) – Feature ID. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_find_user(

query: StrictStr[StrictStr],

**kwargs,

) → FindUserResponse[source]#

Find a user

DEPRECATED. Admin-only API to find a user by username or email address.

Parameters:

query (str) – Part of e-mail address or username (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

FindUserResponse

admin_get_all_active_user_ids(

**kwargs,

) → AdminGetUserIdsResponse[source]#

Get all user IDs (active last 30 days)

DEPRECATED. Admin-only API to get list of all users that have been active in the past 30 days.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUserIdsResponse

admin_get_all_user_ids(

**kwargs,

) → AdminGetUserIdsResponse[source]#

Get all user IDs

DEPRECATED. Admin-only API to get list of all users.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUserIdsResponse

admin_get_data_migration(

migration_id: StrictStr[StrictStr],

**kwargs,

) → AdminGetDataMigrationResponse[source]#

Get data migration

Admin-only API to get a data migration.

Parameters:

migration_id (str) – Data migration ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetDataMigrationResponse

admin_get_data_migrations(

**kwargs,

) → AdminGetDataMigrationsResponse[source]#

Get data migrations

Admin-only API to get data migrations.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetDataMigrationsResponse

admin_get_disallowed_email_domains(

**kwargs,

) → AdminGetDisallowedEmailDomainsResponse[source]#

Get the list of disallowed email domains

Admin-only API to get the list of disallowed email domains.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetDisallowedEmailDomainsResponse

admin_get_email_verification_code(

email: StrictStr[StrictStr],

**kwargs,

) → GetEmailVerificationCodeResponse[source]#

Get enterprise trial email verification code

Get the enterprise trial verification code of the specified email.

Parameters:

email (str) – Email address (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetEmailVerificationCodeResponse

admin_get_feature_flags(

**kwargs,

) → GetFeatureFlagsResponse[source]#

Get all feature flags

Admin-only API to get all feature flags.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetFeatureFlagsResponse

admin_get_job_details(

job_id: StrictInt[StrictInt],

parent_type: JobParentTypeEnum[JobParentTypeEnum],

include_children_jobs: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → JobDetailsResponse[source]#

Get job execution details

Get the job execution details including inner jobs

Parameters:

job_id (int) – Job ID (required)
parent_type (JobParentTypeEnum) – Job parent type (project, organization, or standalone) (required)
include_children_jobs (bool) – Include the details of each of the children jobs (recursively)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

JobDetailsResponse

admin_get_jobs_logs(

job_id: StrictInt[StrictInt],

parent_type: JobParentTypeEnum[JobParentTypeEnum],

limit: StrictInt[StrictInt],

offset: StrictInt[StrictInt],

**kwargs,

) → JobLogsResponse[source]#

Get job logs

Get the logs for a job.

Parameters:

job_id (int) – Job ID (required)
parent_type (JobParentTypeEnum) – Job parent type (project, organization, or standalone) (required)
limit (int) – Maximum number of logs (required)
offset (int) – Start fetching logs from this offset (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

JobLogsResponse

admin_get_jobs_metrics(

job_id: StrictInt[StrictInt],

parent_type: JobParentTypeEnum[JobParentTypeEnum],

**kwargs,

) → JobMetricsResponse[source]#

Get job usage metrics

Get cpu/memory usage metrics, if the job is a Kubernetes job

Parameters:

job_id (int) – Job ID (required)
parent_type (JobParentTypeEnum) – Job parent type (project, organization, or standalone) (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

JobMetricsResponse

admin_get_metrics(

**kwargs,

) → AdminGetMetricsResponse[source]#

Get global metrics

Admin-only API to get global metrics.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetMetricsResponse

admin_get_organization_compute_time_usage(

organization_id: StrictInt[StrictInt],

start_date: datetime[datetime],

end_date: datetime[datetime],

**kwargs,

) → AdminGetOrganizationComputeTimeUsageResponse[source]#

Get organization compute time usage

Admin-only API to get compute time usage for an organization over a period of time.

Parameters:

organization_id (int) – Organization ID (required)
start_date (datetime) – Start date (required)
end_date (datetime) – End date (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetOrganizationComputeTimeUsageResponse

admin_get_organization_data_export(

organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationDataExportResponse[source]#

Get organization data export

Admin-only API to get a data export for an organization.

Parameters:

organization_id (int) – Organization ID (required)
export_id (int) – Export ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataExportResponse

admin_get_organization_data_exports(

organization_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetOrganizationDataExportsResponse[source]#

Get all organization data exports

Admin-only API to get the list of all data exports for an organization.

Parameters:

organization_id (int) – Organization ID (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataExportsResponse

admin_get_organization_info(

organization_id: StrictInt[StrictInt],

include_deleted: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → AdminOrganizationInfoResponse[source]#

Organization information

Admin-only API to list all information about this organization.

Parameters:

organization_id (int) – Organization ID (required)
include_deleted (bool) – Whether to include deleted entities (users, projects, orgs)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminOrganizationInfoResponse

admin_get_organization_usage_report(

organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetOrganizationUsageReportResponse[source]#

Get usage report

Admin-only API to get a usage report for an organization.

Parameters:

organization_id (int) – Organization ID (required)
usage_report_id (int) – Usage report ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetOrganizationUsageReportResponse

admin_get_organization_usage_reports(

organization_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → AdminGetOrganizationUsageReportsResponse[source]#

Get all usage reports

Admin-only API to get all usage reports for an organization.

Parameters:

organization_id (int) – Organization ID (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetOrganizationUsageReportsResponse

Get all organizations

Admin-only API to get the list of all organizations.

Parameters:

active (int) – Whether to search for entities (users, orgs) active in the last X days
include_deleted (bool) – Whether to include deleted entities (users, projects, orgs)
sort (str) – Fields and order to sort query by
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
search (str) – Search query
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetOrganizationsResponse

admin_get_project(

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectInfoResponse[source]#

Get project

Admin-only API to get project information.

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ProjectInfoResponse

Get all projects

Admin-only API to get the list of all projects.

Parameters:

active (int) – Whether to search for entities (users, orgs) active in the last X days
sort (str) – Fields and order to sort query by
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
search (str) – Search query
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminListProjectsResponse

admin_get_sso_domain_id_ps(

domain_name: StrictStr[StrictStr],

**kwargs,

) → AdminGetSSODomainIdPsResponse[source]#

Get SSO settings for a domain

Admin-only API to get the list of identity providers enabled for a given domain.

Parameters:

domain_name (str) – Email domain name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetSSODomainIdPsResponse

admin_get_sso_settings(

**kwargs,

) → AdminGetSSOSettingsResponse[source]#

Get SSO settings

Admin-only API to get the SSO settings.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetSSOSettingsResponse

admin_get_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetUserResponse[source]#

Get user

Admin-only API to get information about a user.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUserResponse

admin_get_user_metrics(

user_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetUserMetricsResponse[source]#

Get user metrics

Admin-only API to get marketing metrics about a user.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUserMetricsResponse

admin_get_user_trial(

user_id: StrictInt[StrictInt],

enterprise_trial_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetUserTrialResponse[source]#

Get user enterprise trial

Admin-only API to get a specific enterprise trial.

Parameters:

user_id (int) – User ID (required)
enterprise_trial_id (int) – Enterprise trial ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUserTrialResponse

Get all users

Admin-only API to get the list of all registered users.

Parameters:

active (int) – Whether to search for entities (users, orgs) active in the last X days
tier (str) – Whether to search for free, pro or enterprise entities (users, projects)
fields (str) – Comma separated list of fields to fetch in a query
sort (str) – Fields and order to sort query by
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
search (str) – Search query
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AdminGetUsersResponse

admin_remove_user_from_organization(

organization_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Remove user from an organization

Admin-only API to remove a user from an organization.

Parameters:

organization_id (int) – Organization ID (required)
user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_remove_user_from_project(

project_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Remove user from a project

Admin-only API to remove a user from a project.

Parameters:

project_id (int) – Project ID (required)
user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_restore_organization(

organization_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Restore an organization

Admin-only API to restore a soft deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.

Parameters:

organization_id (int) – Organization ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_toggle_data_migration(

migration_id: StrictStr[StrictStr],

admin_toggle_data_migration_request: AdminToggleDataMigrationRequest,

**kwargs,

) → GenericApiResponse[source]#

Run or pause a data migration

Admin-only API to run or pause a data migration.

Parameters:

migration_id (str) – Data migration ID (required)
admin_toggle_data_migration_request (AdminToggleDataMigrationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_organization(

organization_id: StrictInt[StrictInt],

admin_update_organization_request: AdminUpdateOrganizationRequest,

**kwargs,

) → GenericApiResponse[source]#

Update organization

Admin-only API to update organization properties such as name and logo.

Parameters:

organization_id (int) – Organization ID (required)
admin_update_organization_request (AdminUpdateOrganizationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_organization_data_export(

organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

admin_update_organization_data_export_request: AdminUpdateOrganizationDataExportRequest,

**kwargs,

) → GenericApiResponse[source]#

Update organization data export

Admin-only API to update a data export for an organization.

Parameters:

organization_id (int) – Organization ID (required)
export_id (int) – Export ID (required)
admin_update_organization_data_export_request (AdminUpdateOrganizationDataExportRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_project(

project_id: StrictInt[StrictInt],

update_project_request: UpdateProjectRequest,

**kwargs,

) → GenericApiResponse[source]#

Update project

Admin-only API to update project properties.

Parameters:

project_id (int) – Project ID (required)
update_project_request (UpdateProjectRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_user(

user_id: StrictInt[StrictInt],

admin_update_user_request: AdminUpdateUserRequest,

**kwargs,

) → GenericApiResponse[source]#

Update user

Admin-only API to update user properties.

Parameters:

user_id (int) – User ID (required)
admin_update_user_request (AdminUpdateUserRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_user_permissions(

user_id: StrictInt[StrictInt],

admin_update_user_permissions_request: AdminUpdateUserPermissionsRequest,

**kwargs,

) → GenericApiResponse[source]#

Update user permissions

Admin-only API to update the list of permissions for a user.

Parameters:

user_id (int) – User ID (required)
admin_update_user_permissions_request (AdminUpdateUserPermissionsRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_update_user_trial(

user_id: StrictInt[StrictInt],

enterprise_trial_id: StrictInt[StrictInt],

admin_update_user_trial_request: AdminUpdateUserTrialRequest,

**kwargs,

) → GenericApiResponse[source]#

Update user enterprise trial

Admin-only API to update an enterprise trial for a user.

Parameters:

user_id (int) – User ID (required)
enterprise_trial_id (int) – Enterprise trial ID (required)
admin_update_user_trial_request (AdminUpdateUserTrialRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

admin_upgrade_user_trial(

user_id: StrictInt[StrictInt],

enterprise_trial_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Upgrade user enterprise trial to a full enterprise account

Admin-only API to upgrade a specific enterprise trial for a user to a full enterprise account.

Parameters:

user_id (int) – User ID (required)
enterprise_trial_id (int) – Enterprise trial ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse