picture#

Autogenerated API

argus_api.lib.currentuser.v1.picture.get_profile_picture(width: int = None, height: int = None, size: str = None, default: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → requests.models.Response#

Get current user’s profile picture (PUBLIC)

Parameters

  • width (int) – If set, rescale image to the smallest size above this width in pixels (keep aspect ratio)

  • height (int) – If set, rescale image to the smallest size above this height in pixels (keep aspect ratio)

  • size (str) – If set, rescale image to this predefined size

  • default (bool) – If true, return default avatar image if user picture not set. Default is false.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object

argus_api.lib.currentuser.v1.picture.update_profile_picture_json(image: str = None, mimeType: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Set current user’s profile picture (PUBLIC) (PUBLIC)

Parameters

  • image (str) – Image bytes

  • mimeType (str) – Image MIME type => Sanitize by regex image/(png|jpe?g)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON