user#

Autogenerated API

argus_api.lib.users.v2.user.get_basic_user(shortNameOrID: str, domain: 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#

Get a basic user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

  • domain (str) – Name or ID of the domain of the user

  • 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.users.v2.user.get_user_image(shortNameOrID: str, domain: str = None, size: str = None, width: int = None, height: int = 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#

Returns user profile picture. (PUBLIC)

Parameters

  • shortNameOrID (str) – User ID or username

  • domain (str) – Domain ID or short name (optional, defaults to current user domain)

  • size (str) – The preferred size of the image (small, medium, large, xlarge), should not be used together with parameters ‘width’ and ‘height’, will crop the original image if it is not a square (optional)

  • width (int) – The preferred width of the image. Preserves aspect ratio if height is not set (optional)

  • height (int) – The preferred height of the image. Preserves aspect ratio if width is not set (optional)

  • 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.users.v2.user.list_basic_users(domain: str = None, subject: str = None, customer: str = None, excludeFlag: str = None, includeFlag: str = None, keyword: str = None, keywords: str = None, keywordField: str = None, sortBy: str = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, includeDeleted: 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#

Returns the basic users matching the query (PUBLIC)

Parameters

  • domain (list) – Domain to search in by short name or id

  • subject (list) – Subject to search for by short name or id

  • customer (list) – Customer to search for by short name or id

  • excludeFlag (list) – Exclude subjects with flag

  • includeFlag (list) – Include subjects with flag

  • keyword (list) – DEPRECATED: Use ‘keywords’ instead

  • keywords (list) – Search by keywords

  • keywordField (list) – Set field strategy for keyword search

  • sortBy (list) – Field to sort by

  • limit (int) – Maximum number of returned results

  • keywordMatch (str) – Set match strategy for keyword search

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted subjects

  • 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.users.v2.user.search_basic_users(domain: str = None, subject: str = None, ancestor: str = None, customer: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, permissions: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, subCriteria: dict = None, includeDeleted: bool = 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#

Returns the basic users matching the query (PUBLIC)

Parameters

  • domain (list) – Restrict the search to subjects in these domains, by domain ID or name.

  • subject (list) – Restrict search to specific subjects, by ID or shortname

  • ancestor (list) – Restrict search to subjects descending from specific groups, by ID or shortname. This will not include deleted ancestors if includeDeleted is set

  • customer (list) – Restrict search to subjects bound to these customers (by ID or shortname). Customer groups will resolve to all sub customers as well.

  • sortBy (list) – Define sort order (default name)

  • includeFlags (list) – Restrict search to subjects having all of the specified flags.

  • excludeFlags (list) – Exclude subjects with these flags from the search.

  • permissions (list) – Limit search to subjects with one of the given permissions

  • keywords (list) – Keywords to search for

  • keywordMatchStrategy (str) – Search strategy to use when searching (default Match all keywords)

  • keywordFieldStrategy (list) – Which fields will be searched for the given keyword (default All supported fields)

  • subCriteria (list) – Set additional criteria with AND, OR or AND NOT

  • includeDeleted (bool) – Whether or not to include deleted subjects. This will include deleted groups and users (default false)

  • limit (int) – The max amount of items to display (default 25)

  • offset (int) – The amount of items to skip (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