admin_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.admin_api module
class edgeimpulse_api.api.admin_api.AdminApi(api_client=None)Bases:
object
admin_add_or_update_sso_domain_id_ps(domain_name: StrictStr, admin_add_or_update_sso_domain_id_ps_request: AdminAddOrUpdateSSODomainIdPsRequest, **kwargs)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
admin_add_user_to_project(project_id: StrictInt, admin_add_project_user_request: Optional[AdminAddProjectUserRequest] = None, **kwargs)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
admin_create_organization(admin_create_organization_request: AdminCreateOrganizationRequest, **kwargs)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
admin_delete_organization(organization_id: StrictInt, full_deletion: Optional[StrictBool] = None, **kwargs)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
admin_delete_project(project_id: StrictInt, **kwargs)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
admin_delete_sso_domain_id_ps(domain_name: StrictStr, **kwargs)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
admin_delete_user(user_id: StrictInt, full_deletion: Optional[StrictBool] = None, **kwargs)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
admin_find_user(query: StrictStr, **kwargs)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
admin_get_all_active_user_ids(**kwargs)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
admin_get_all_user_ids(**kwargs)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
admin_get_metrics(**kwargs)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
admin_get_organization_info(organization_id: StrictInt, **kwargs)Organization information
Admin-only API to list all information about this organization.
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
admin_get_organizations(active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)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
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
admin_get_project(project_id: StrictInt, **kwargs)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
admin_get_projects(active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)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
admin_get_sso_domain_id_ps(domain_name: StrictStr, **kwargs)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
admin_get_sso_settings(**kwargs)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
admin_get_user(user_id: StrictInt, **kwargs)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
admin_get_user_metrics(user_id: StrictInt, **kwargs)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
admin_get_users(active: Optional[StrictInt] = None, tier: Optional[StrictStr] = None, fields: Optional[StrictStr] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)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
admin_remove_user_from_project(project_id: StrictInt, user_id: StrictInt, **kwargs)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
admin_update_organization(organization_id: StrictInt, admin_update_organization_request: AdminUpdateOrganizationRequest, **kwargs)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
admin_update_project(project_id: StrictInt, update_project_request: UpdateProjectRequest, **kwargs)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
admin_update_user(user_id: StrictInt, admin_update_user_request: AdminUpdateUserRequest, **kwargs)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
Last updated
Was this helpful?