constrain#

Autogenerated API

argus_api.lib.authentication.v1.constrain.constrain(customer: str = None, function: str = None, readOnly: 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) → dict#

Request a constrained session (PUBLIC)

Parameters

  • customer (list) – Set of customers the session should be valid for (default is all current customers). Cannot extend the current set of customers.

  • function (list) – Set of functions/roles (by name) the session should be granted (default is all current functions). Cannot extend the current set of functions.

  • readOnly (bool) – If true, this session will be constrained to read only (default 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.

Returns

dictionary translated from JSON