userrole#

Autogenerated API

argus_api.lib.customeradmin.v2.userrole.list_customer_user_roles(domain: str = None, customer: str = None, role: str = None, user: str = None, limit: int = 25, 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#

Search user roles with specified query parameters (PUBLIC)

Parameters

  • domain (str) – Filter search by domain

  • customer (list) – Filter search by customers ids or short names

  • role (list) – Filter search by user roles (e.g. array[‘logManager’, ‘tiManager’])

  • user (list) – Filter search by user ids or short names

  • limit (int) – Limit result

  • offset (int) – Offset result

  • 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

argus_api.lib.customeradmin.v2.userrole.search_customer_user_roles(domain: str = None, customer: str = None, user: str = None, role: str = None, limit: int = 25, 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#

Search user roles with specified criteria (PUBLIC)

Parameters

  • domain (str) – Limit search to user roles with the given domain, identified by id or shortname

  • customer (list) – Limit search to user roles with the given customers, identified by id or shortname

  • user (list) – Limit search to user roles with the given users, identified by id or shortname

  • role (list) – Limit search to given user roles, defaults to return all user roles

  • limit (int) – Limit maximum amount of results (default 25)

  • offset (int) – Skip specified amount of results (default 0)

  • 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