organizations_api module

OrganizationsApi

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

Parameters

  • api_client=None

Methods

add_organization_api_key

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

Add API key

Add an API key.

Parameters

  • self

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

  • add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

add_organization_member

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

Add member

Add a member to an organization.

Parameters

  • self

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

  • add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

create_organization

edgeimpulse_api.api.organizations_api.create_organization(
		self,
		create_organization_request: edgeimpulse_api.models.create_organization_request.CreateOrganizationRequest,
		**kwargs
)> edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

Create new organization

Create a new organization. This is an internal API.

Parameters

  • self

  • create_organization_request: edgeimpulse_api.models.create_organization_request.CreateOrganizationRequest

  • **kwargs

Return

edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

delete_organization

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