subject#

Autogenerated API

argus_api.lib.useradmin.v2.subject.add_subject_group_memberships(shortNameOrID: str, domain: str = None, parentGroups: str = None, comment: 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 this subject to one or multiple groups (DEV)

Parameters

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

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

  • parentGroups (list) – ID or shortname of groups to add membership to

  • comment (str) – Comment to describe the reason for this change

  • 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.subject.get_subject(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#

Returns the specified subject (PUBLIC)

Parameters

  • shortNameOrId (str) – ID or shortname of subject to fetch

  • domain (str) – Domain ID or short name (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.useradmin.v2.subject.get_subject_1(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#

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

argus_api.lib.useradmin.v2.subject.list_subjects(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 subjects 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.useradmin.v2.subject.list_subjects_1(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#

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

argus_api.lib.useradmin.v2.subject.search_subjects(domain: str = None, subject: str = None, ancestor: str = None, parent: str = None, customer: str = None, type: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, permissions: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, endTimestamp: int = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, subCriteria: dict = None, includeDeleted: bool = None, startTimestamp: int = 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 subjects 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

  • parent (list) – Restrict search to subjects which are direct member of specific groups, by ID or shortname

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

  • type (str) – Limit search to one type of subject

  • sortBy (list) – Field to sort by (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 based on all keywords (AND), or based on any keyword (OR) (default Match all keywords (AND))

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

  • endTimestamp (int) – The end time of the search (default now)

  • timeMatchStrategy (str) – Search based on all time-field (AND), or based on any time-field (OR) (default Match any field)

  • timeFieldStrategy (list) – The fields to limit the time search to (default All 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)

  • startTimestamp (int) – The start time of the search (default 0)

  • 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

requests.Response object or dictionary translated from JSON