group#
Autogenerated API
- argus_api.lib.useradmin.v2.group.add_group(customer: str = None, shortName: str = None, name: str = None, description: str = None, externallyManaged: bool = None, daemonAccount: 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 Group (PUBLIC)
- Parameters
customer (str) – The shortname or ID for customer to register the subject to
shortName (str) – The shortname of the subject => Sanitize by regex [a-zA-Z0-9_\-.@]+
name (str) – The name of the subject => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
description (str) – The description of the subject => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
externallyManaged (bool) – Whether the subject is managed externally (default false)
daemonAccount (bool) – If set, mark the group as a group for daemon accounts (default false)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.add_group_members(shortNameOrID: str, domain: str = None, subject: 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 a set of subjects to a group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
subject (list) – ID or shortname of subjects to add to the group
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.delete_group(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 #
Deletes a group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.get_group(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 group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.list_groups_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 #
Returns the groups 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 groups with flag
includeFlag (list) – Include groups 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 groups
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.list_permissions_for_group(shortNameOrID: str, domain: str = None, limit: int = 25, includeInherited: bool = True, 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 #
List permissions for a group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
limit (int) – Maximum number of returned results
includeInherited (bool) – Include inherited permission
offset (int) – Skip a number of results
includeDeleted (bool) – Include deleted permission
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.list_subjects_in_group(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 #
Fetches the set of active members of a group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.move_group(shortNameOrID: str, domain: str = None, customer: 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 #
Move a group to another customer (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Domain ID or short name (optional, defaults to current user domain)
customer (str) – ID or shortname of customer to move the subject to. The customer must be in same domain as the subject.
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.reenable_group(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 #
Reenables a deleted group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.remove_subjects_from_group(shortNameOrID: str, subject: str, domain: 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 #
Removes a set of members from the group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
subject (list) – Subjects to remove from group
domain (str) – Name or ID of the domain of the group
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.search_groups(userMatchStrategy: str = None, userFieldStrategy: str = None, domain: str = None, subject: str = None, ancestor: str = None, parent: 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, 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 groups matching the query (PUBLIC)
- Parameters
userMatchStrategy (str) –
userFieldStrategy (list) –
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.
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
requests.Response
object or dictionary translated from JSON
- argus_api.lib.useradmin.v2.group.update_group(shortNameOrID: str, domain: str = None, shortName: str = None, name: str = None, description: str = None, externallyManaged: bool = None, daemonAccount: 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 group (PUBLIC)
- Parameters
shortNameOrID (str) – Short name or ID of group
domain (str) – Name or ID of the domain of the group
shortName (str) – The shortname of the subject => Sanitize by regex [a-zA-Z0-9_\-.@]+
name (str) – The name of the subject => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
description (str) – The description of the subject => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
externallyManaged (bool) – Whether the subject is managed externally
daemonAccount (bool) – If set, change the daemon flag for this group
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON