organization_requires_admin_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_requires_admin_api module

class edgeimpulse_api.api.organization_requires_admin_api.OrganizationRequiresAdminApi(api_client=None)

Bases: object

add_organization_bucket(organization_id: StrictInt, add_organization_bucket_request: AddOrganizationBucketRequest, **kwargs)

Add a storage bucket

Add a storage bucket.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • add_organization_bucket_request (AddOrganizationBucketRequest) – (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.

add_organization_member(organization_id: StrictInt, add_member_request: AddMemberRequest, **kwargs)

Add member

Add a member to an organization.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • add_member_request (AddMemberRequest) – (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.

delete_organization(organization_id: StrictInt, **kwargs)

Remove organization

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

  • 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.

invite_organization_member(organization_id: StrictInt, invite_organization_member_request: InviteOrganizationMemberRequest, **kwargs)

Invite member

Invite a member to an organization.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • invite_organization_member_request (InviteOrganizationMemberRequest) – (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.

remove_organization_bucket(organization_id: StrictInt, bucket_id: StrictInt, **kwargs)

Remove storage bucket

Remove a storage bucket. This will render any data in this storage bucket unreachable.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • bucket_id (int) – Bucket 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.

remove_organization_member(organization_id: StrictInt, remove_member_request: RemoveMemberRequest, **kwargs)

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

    • organization_id (int) – Organization ID (required)

    • remove_member_request (RemoveMemberRequest) – (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.

revoke_organization_api_key(organization_id: StrictInt, api_key_id: StrictInt, **kwargs)

Revoke API key

Revoke an API key.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • api_key_id (int) – API key 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.

set_organization_member_datasets(organization_id: StrictInt, member_id: StrictInt, set_member_datasets_request: SetMemberDatasetsRequest, **kwargs)

Set member datasets

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • member_id (int) – Member ID (required)

    • set_member_datasets_request (SetMemberDatasetsRequest) – (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.

set_organization_member_role(organization_id: StrictInt, member_id: StrictInt, set_member_role_request: SetMemberRoleRequest, **kwargs)

Set member role

Change the role of a member in an organization.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • member_id (int) – Member ID (required)

    • set_member_role_request (SetMemberRoleRequest) – (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.

test_organization_admin(organization_id: StrictInt, **kwargs)

Admin endpoint

Test endpoint that can only be reached with admin rights.

  • 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.

update_organization(organization_id: StrictInt, update_organization_request: UpdateOrganizationRequest, **kwargs)

Update organization

Update organization properties such as name and logo.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • update_organization_request (UpdateOrganizationRequest) – (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.

update_organization_bucket(organization_id: StrictInt, bucket_id: StrictInt, update_organization_bucket_request: UpdateOrganizationBucketRequest, **kwargs)

Update storage bucket

Updates storage bucket details. This only updates fields that were set in the request body.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • bucket_id (int) – Bucket ID (required)

    • update_organization_bucket_request (UpdateOrganizationBucketRequest) – (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.

upload_organization_header(organization_id: StrictInt, image: Optional[StrictStr] = None, **kwargs)

Upload organization header image

Uploads and updates the organization header image

  • Parameters

    • organization_id (int) – Organization ID (required)

    • image (str) –

    • 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.

upload_organization_logo(organization_id: StrictInt, image: Optional[StrictStr] = None, **kwargs)

Upload organization logo

Uploads and updates the organization logo

  • Parameters

    • organization_id (int) – Organization ID (required)

    • image (str) –

    • 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.

whitelabel_admin_create_organization(organization_id: StrictInt, whitelabel_admin_create_organization_request: WhitelabelAdminCreateOrganizationRequest, **kwargs)

Create new organization within white label context

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • whitelabel_admin_create_organization_request (WhitelabelAdminCreateOrganizationRequest) – (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.

whitelabel_admin_get_metrics(organization_id: StrictInt, **kwargs)

Get global white label metrics

White label admin only API to get global metrics.

  • 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.

whitelabel_admin_get_organization_info(organization_id: StrictInt, inner_organization_id: StrictInt, **kwargs)

Get organization information

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • inner_organization_id (int) – Organization ID within the context of a white label (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.

whitelabel_admin_get_organizations(organization_id: StrictInt, active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)

Get all organizations within a white label

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

whitelabel_admin_get_project(organization_id: StrictInt, project_id: StrictInt, **kwargs)

Get a white label project

White label admin only API to get project information.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

whitelabel_admin_get_projects(organization_id: StrictInt, active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)

Get all white label projects

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

whitelabel_admin_get_user(organization_id: StrictInt, user_id: StrictInt, **kwargs)

Get a white label user

White label admin only API to get information about a user.

  • 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.

whitelabel_admin_get_user_metrics(organization_id: StrictInt, user_id: StrictInt, **kwargs)

Get white label user metrics

White label admin only API to get marketing metrics about a user.

  • 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.

whitelabel_admin_get_users(organization_id: StrictInt, 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 white label users

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

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

whitelabel_admin_update_organization(organization_id: StrictInt, inner_organization_id: StrictInt, admin_update_organization_request: AdminUpdateOrganizationRequest, **kwargs)

Update organization

White label admin only API to update organization properties such as name and logo.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • inner_organization_id (int) – Organization ID within the context of a white label (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.

whitelabel_admin_update_project(organization_id: StrictInt, project_id: StrictInt, update_project_request: UpdateProjectRequest, **kwargs)

Update white label project

White label admin only API to update project properties.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

whitelabel_admin_update_user(organization_id: StrictInt, user_id: StrictInt, admin_update_user_request: AdminUpdateUserRequest, **kwargs)

Update white label user

White label admin only API to update user properties.

  • Parameters

    • organization_id (int) – Organization ID (required)

    • 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.

Last updated

Was this helpful?