groups#

Autogenerated API

argus_api.lib.currentuser.v1.groups.get_current_user_groups(limit: int = 25, includeAncestors: bool = None, offset: int = 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#

Get list of groups which current user is a member of. Result will be sorted by id (ascending) (PUBLIC)

Parameters

  • limit (int) – Maximum number of values to return

  • includeAncestors (bool) – If true, also include group ancestors

  • offset (int) – Skip this number of records

  • 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