permission#

Autogenerated API

argus_api.lib.useradmin.v2.permission.grant_permission(subject: str = None, customer: str = None, function: 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#

Grants a permission to a user (PUBLIC)

Parameters

  • subject (str) – Subject to grant the function to (id or name)

  • customer (str) – Customer that the function is valid for (id or name)

  • function (str) – Function to grant (id or name)

  • 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.permission.grant_permissions_bulk(permissions: dict = 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#

Bulk-grant permissions (PUBLIC)

Parameters

  • permissions (list) – A set of permissions to grant

  • 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.permission.list_permissions(domain: str = None, subject: str = None, customer: str = None, function: str = None, keywords: str = None, keywordField: str = None, limit: int = 25, includeSubjectAscendants: bool = True, includeSubjectDescendants: bool = True, includeCustomerAscendants: bool = True, includeCustomerDescendants: bool = True, includeFunctionAscendants: bool = True, includeFunctionDescendants: bool = True, 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#

Searches for permissions, defaults to showing all permissions (PUBLIC)

Parameters

  • domain (str) – Name or ID of the domain to search

  • subject (list) – Name or ID of the subject

  • customer (list) – Name or ID of the customer

  • function (list) – Name or ID of the function

  • keywords (list) – Search by keywords

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

  • limit (int) – Maximum number of returned results

  • includeSubjectAscendants (bool) – Include permissions for ascending subjects

  • includeSubjectDescendants (bool) – Include permissions for descending subjects

  • includeCustomerAscendants (bool) – Include permissions for ascending customers

  • includeCustomerDescendants (bool) – Include permissions for descending customers

  • includeFunctionAscendants (bool) – Include permissions for ascending functions

  • includeFunctionDescendants (bool) – Include permissions for descending functions

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

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted permissions

  • 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.permission.revoke_permission(permissionID: int, 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#

Revokes a permission from a user (PUBLIC)

Parameters

  • permissionID (int) – ID of permission

  • 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.permission.revoke_permissions_bulk(permission: int, 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#

Revokes a set of permissions (DEV)

Parameters

  • permission (list) – ID of permissions to revoke

  • 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.permission.search_permissions(subCriteria: dict = None, keywordMatchStrategy: str = None, keywords: str = None, keywordFieldStrategy: str = None, startTimestamp: str = None, endTimestamp: str = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, subject: str = None, customer: str = None, function: str = None, domain: str = None, sortBy: str = None, includeSubjectAscendants: bool = True, includeSubjectDescendants: bool = True, includeCustomerAscendants: bool = True, includeCustomerDescendants: bool = True, includeFunctionAscendants: bool = True, includeFunctionDescendants: bool = True, 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#

Searches for permissions, defaults to showing all permissions (PUBLIC)

Parameters

  • subCriteria (list) –

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

  • keywords (list) – Keywords to search for

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

  • startTimestamp (str) – Restrict search to data after this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to data before this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • timeMatchStrategy (str) – Specify if the specified time period must match all the searched time fields, or if it will match for any field. Default is any.

  • timeFieldStrategy (list) – Determine fields to search for by time (defaults to all)

  • subject (list) – The ID or shortname of subjects to search for

  • customer (list) – The ID or shortname of customers to search for

  • function (list) – The ID or shortname of functions to search for

  • domain (str) – The ID or shortname of the domain where the subjects and customers are located

  • sortBy (list) – Field to sort result by (will sort by the fields ID, not name) (default subject)

  • includeSubjectAscendants (bool) – Incude permissions given for subject ascendants (default true)

  • includeSubjectDescendants (bool) – Incude permissions given for subject descendants (default true)

  • includeCustomerAscendants (bool) – Incude permissions given for customer ascendants (default true)

  • includeCustomerDescendants (bool) – Incude permissions given for customer descendants (default true)

  • includeFunctionAscendants (bool) – Incude permissions given for function ascendants (default true)

  • includeFunctionDescendants (bool) – Incude permissions given for function descendants (default true)

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