user#

Autogenerated API

argus_api.lib.users.v1.user.check_permission(userId: int, function: 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: Use GET useradmin/v2/user/{shortNameOrID}/permissions. Validate user permission to perform function (PUBLIC)

Parameters

  • userId (int) – ID of user

  • function (str) – Function 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.users.v1.user.find_users(domain: str = None, type: str = None, subjectID: int = None, excludeSubjectID: int = None, parentID: int = None, ancestorID: int = None, get_aclAncestorID: int = None, get_aclCustomerID: int = None, excludeAncestorID: int = None, userName: str = None, email: str = None, mobile: str = None, searchString: str = None, requiredFunctionID: int = None, requiredFunctionCustomerID: int = None, requireAllFunctions: bool = None, limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: 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#

DEPRECATED: Use POST users/v2/user/search. Search user profiles (PUBLIC)

Parameters

  • domain (list) –

  • type (str) –

  • subjectID (list) –

  • excludeSubjectID (list) –

  • parentID (list) –

  • ancestorID (list) –

  • get_aclAncestorID (list) –

  • get_aclCustomerID (list) –

  • excludeAncestorID (list) –

  • userName (list) –

  • email (list) –

  • mobile (list) –

  • searchString (str) –

  • requiredFunctionID (list) –

  • requiredFunctionCustomerID (int) –

  • requireAllFunctions (bool) –

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • 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.v1.user.get_functions(userId: int, onlyRoles: bool = None, keywords: 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#

DEPRECATED: Use GET useradmin/v2/user/{shortNameOrID}/permissions List a user’s permission functions regardless of customer (PUBLIC)

Parameters

  • userId (int) – ID of user

  • onlyRoles (bool) – Only return functions marked as roles

  • keywords (list) – Filter functions by keywords on name and description

  • limit (int) – Maximum number of returned functions

  • offset (int) – Skip a number of 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.users.v1.user.get_profile(userId: int, 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: Use GET users/v2/user/{shortNameOrID}>. Get user profile by ID (PUBLIC)

Parameters

  • userId (int) – ID of 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.v1.user.get_user_by_username(userName: 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: Use GET users/v2/user/{shortNameOrID}. Get user profile by username (PUBLIC)

Parameters

  • userName (str) – Username

  • 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.v1.user.get_user_customers(userId: int, offset: int = None, keywords: str = None, keywordField: str = None, limit: int = 25, keywordMatch: str = 'all', 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: Use POST /customers/v1/customer/search. List a user’s customers. (PUBLIC)

Parameters

  • userId (int) – ID of user

  • offset (int) – Offset results

  • keywords (list) – Search by keywords

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

  • limit (int) – Limit results

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

  • 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.v1.user.get_user_profile_picture(user: str, domain: str = 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#

DEPRECATED: Use GET /user/{shortNameOrID}/picture. Returns user profile picture. (PUBLIC)

Parameters

  • user (str) – User ID or username

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

  • 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.v1.user.list_users(subjectID: int = None, offset: int = None, limit: int = 25, 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 : list_users is an alias for list_users_v1. Exists only for backward compatibility - do not use - use list_users_v1 instead.

argus_api.lib.users.v1.user.list_users_v1(subjectID: int = None, offset: int = None, limit: int = 25, 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: Use GET users/v2/user. Get user profiles (PUBLIC)

Parameters

  • subjectID (list) – IDs of users

  • offset (int) – Offset results

  • limit (int) – Limit results

  • 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.v1.user.update_profile_picture_for_user_form(userID: 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#

DEPRECATED: Use PUT /user/{shortNameOrID}/picture. Upload and modify the user image (PUBLIC)

Parameters

  • userID (str) – ID or username of user to change image for

  • domain (str) – Domain of the user (defaults to current users domain

  • 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.v1.user.update_profile_picture_for_user_j_s_o_n(userId: str, domain: str = None, image: str = None, mimeType: 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#

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

argus_api.lib.users.v1.user.update_profile_picture_for_user_json(userId: str, domain: str = None, image: str = None, mimeType: 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#

DEPRECATED: Use PUT /user/{shortNameOrID}/picture. Upload and modify the user image (PUBLIC)

Parameters

  • userId (str) – ID or username of user to change image for

  • domain (str) – Domain of the user (defaults to current users domain

  • image (str) – The image to upload (in base64)

  • mimeType (str) – The MIME type of the image => Sanitize by regex .+/.+

  • 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.v1.user.update_user_preferences(user: 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#

DEPRECATED: Use PUT useradmin/v2/user/{shortNameOrID}/preferences. Updates users preferences. Body should be a map of preferences to set.Any preference with a null value will be deleted. (PUBLIC)

Parameters

  • user (str) – User ID or username

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

  • 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.v1.user.view_user_preferences(user: 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#

DEPRECATED: USE GET useradmin/v2/user/{shortNameOrID}/preferences. View users preferences. (PUBLIC)

Parameters

  • user (str) – User ID or username

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

  • 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