subject#

Autogenerated API

argus_api.lib.users.v1.subject.find_subjects(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/subject/search. Search user or group 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.subject.get_subject_by_id(subjectID: 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/subject/{shortNameOrID}. Get user or group profile by ID (PUBLIC)

Parameters

  • subjectID (int) – ID of subject

  • 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.subject.get_subject_by_name(subjectName: 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/subject/{shortNameOrID}. Get user or group profile by name (PUBLIC)

Parameters

  • subjectName (str) – Username or group shortname

  • 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.subject.list_subjects(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_subjects is an alias for list_subjects_v1. Exists only for backward compatibility - do not use - use list_subjects_v1 instead.

argus_api.lib.users.v1.subject.list_subjects_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 POST users/v2/subject/search. Get user or group profiles (PUBLIC)

Parameters

  • subjectID (list) – IDs of subjects

  • 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