third_party_auth_api module

ThirdPartyAuthApi

class edgeimpulse_api.api.third_party_auth_api.ThirdPartyAuthApi(
		api_client=None
)

Parameters

• api_client=None

Methods

authorize_third_party

edgeimpulse_api.api.third_party_auth_api.authorize_third_party(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})],
		next_url: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The URL to redirect to after authorization is completed.', extra={})],
		**kwargs
) ‑> None

Give access to project

Authorize a third party to access a project

Parameters

• self

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

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

• next_url: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The URL to redirect to after authorization is completed.', extra={})]

• **kwargs

Return

None

create_third_party_auth

edgeimpulse_api.api.third_party_auth_api.create_third_party_auth(
		self,
		create_third_party_auth_request: edgeimpulse_api.models.create_third_party_auth_request.CreateThirdPartyAuthRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_third_party_auth_response.CreateThirdPartyAuthResponse

Create third party auth

Create a new third party authentication partner

Parameters

• self

• create_third_party_auth_request: edgeimpulse_api.models.create_third_party_auth_request.CreateThirdPartyAuthRequest

• **kwargs

Return

edgeimpulse_api.models.create_third_party_auth_response.CreateThirdPartyAuthResponse

create_user_third_party

edgeimpulse_api.api.third_party_auth_api.create_user_third_party(
		self,
		auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})],
		create_user_third_party_request: edgeimpulse_api.models.create_user_third_party_request.CreateUserThirdPartyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_user_third_party_response.CreateUserThirdPartyResponse

Create or login a user

Login as a user as a third-party authentication provider. If the user does not exists, it's automatically created. You can only log in as users that were previously created by you.

Parameters

• self

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

• create_user_third_party_request: edgeimpulse_api.models.create_user_third_party_request.CreateUserThirdPartyRequest

• **kwargs

Return

edgeimpulse_api.models.create_user_third_party_response.CreateUserThirdPartyResponse

delete_third_party_auth

edgeimpulse_api.api.third_party_auth_api.delete_third_party_auth(
		self,
		auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete third party auth

Delete a third party authentication partner

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_all_third_party_auth

edgeimpulse_api.api.third_party_auth_api.get_all_third_party_auth(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.get_all_third_party_auth_response.GetAllThirdPartyAuthResponse

Get all third party auth

Get information about all third party authentication partners

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.get_all_third_party_auth_response.GetAllThirdPartyAuthResponse

get_third_party_auth

edgeimpulse_api.api.third_party_auth_api.get_third_party_auth(
		self,
		auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_third_party_auth_response.GetThirdPartyAuthResponse

Get third party auth

Get information about a third party authentication partner

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_third_party_auth_response.GetThirdPartyAuthResponse

update_third_party_auth

edgeimpulse_api.api.third_party_auth_api.update_third_party_auth(
		self,
		auth_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Auth ID', extra={})],
		update_third_party_auth_request: edgeimpulse_api.models.update_third_party_auth_request.UpdateThirdPartyAuthRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update third party auth

Update a third party authentication partner

Parameters

• self

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

• update_third_party_auth_request: edgeimpulse_api.models.update_third_party_auth_request.UpdateThirdPartyAuthRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse