function#

Autogenerated API

argus_api.lib.useradmin.v2.function.add_function(name: str = None, parent: str = None, description: str = None, minimumSecurityLevel: str = None, role: bool = None, sysadm: 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#

Add new function with a parent function (PUBLIC)

Parameters
  • name (str) – The name of the function => [a-zA-Z0-9_:\-.]*

  • parent (str) – The functions parent (id or name)

  • description (str) – Describes what the function does => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • minimumSecurityLevel (str) – The minimum security level of the function. (default standard)

  • role (bool) – Can this function be assigned to a user? (default false)

  • sysadm (bool) – Mark this function as a sysadm function? (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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.useradmin.v2.function.add_function_child(functionNameOrID: str, children: 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#

Adds functions to a parent function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • children (list) – The children to add to the function (id or name)

  • 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.useradmin.v2.function.delete_function(functionNameOrID: str, 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#

Deletes a function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • 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.useradmin.v2.function.delete_user(functionNameOrID: str, 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#

DEPRECATED : delete_user is an alias for delete_function. Exists only for backward compatibility - do not use - use delete_function instead.

argus_api.lib.useradmin.v2.function.get_function(functionNameOrID: str, 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 function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • 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.useradmin.v2.function.list_function_children(functionNameOrID: str, 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 children of a function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • 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.useradmin.v2.function.list_function_parents(functionNameOrID: str, 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 parents of a function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • 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.useradmin.v2.function.list_functions(function: str = None, minimumSecurityLevel: str = None, excludeFlag: str = None, includeFlag: str = None, ancestor: str = None, descendant: 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 functions matching the query (PUBLIC)

Parameters
  • function (list) – Search by function name or ID

  • minimumSecurityLevel (str) – Specifies the minimum security level of functions to be returned

  • excludeFlag (list) – Exclude functions with flag

  • includeFlag (list) – Include functions with flag

  • ancestor (list) – Search in ancestors of function

  • descendant (list) – Search in descendants of function

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

  • keywords (list) – Search by keywords

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

  • sortBy (list) – Sort search result

  • 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 functions

  • 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.useradmin.v2.function.remove_function_child(functionNameOrID: str, child: str, 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#

Removes functions from a parent function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • child (list) – Name or ID of child functions to remove

  • 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.useradmin.v2.function.search_functions(function: str = None, ancestors: str = None, descendants: str = None, minimumSecurityLevel: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, sortBy: str = 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 functions matching the query (PUBLIC)

Parameters
  • function (list) – Function to search for (name or id)

  • ancestors (list) – Specifies the function ancestors to search in. Can be the name or id

  • descendants (list) – Specifies the function descendants to search in. Can be the name or id

  • minimumSecurityLevel (str) – Specifies the minimum security level of functions to be returned

  • includeFlags (list) – Include functions that have all these flags set

  • excludeFlags (list) – Exclude flags that have any of these flags set

  • subCriteria (list) – Subcriteria to add to the search

  • keywords (list) – Keywords to search for

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

  • keywordMatchStrategy (str) – Search based on all keywords (AND), or based on any keyword (OR) (default Match all keywords (AND))

  • sortBy (list) – Field to sort result by (default name)

  • includeDeleted (bool) – Include deleted functions? (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

argus_api.lib.useradmin.v2.function.update_function(functionNameOrID: str, name: str = None, description: str = None, minimumSecurityLevel: str = None, role: bool = None, sysadm: 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#

Update a function (PUBLIC)

Parameters
  • functionNameOrID (str) – The name or id of the function

  • name (str) – The new name of the function => [a-zA-Z0-9_:\-.]*

  • description (str) – Describes what the function does => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • minimumSecurityLevel (str) – The new minimum security level of the function.

  • role (bool) – If set to true this function is marked as a role

  • sysadm (bool) – If set to true this is marked as a sysadm function

  • 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