customer#
Autogenerated API
- argus_api.lib.customers.v1.customer.add_customer(name: str = None, shortName: str = None, language: str = None, properties: dict = None, logoURL: str = None, timeZone: str = None, accountManagerID: int = None, type: str = None, features: str = None, parentID: int = None, excludeFromProduction: bool = None, networkBaseCustomer: bool = None, singleNetworkDomain: 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 #
Create a new customer (PUBLIC)
- Parameters
name (str) – Name to set for new customer. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
shortName (str) – shortName to set for new customer (must be unique). => [a-zA-Z0-9_:\-.]*
language (str) – Language to set for customer. (default ENGLISH)
properties (dict) – Properties to set for customer. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
logoURL (str) – Customer logo data url. On format data:image/jpeg;base64,BASE64STRING. => Sanitize by regex data:.*
timeZone (str) – Name of timezone to set for customer. (default Europe/Oslo)
accountManagerID (int) – ID of account manager to assign to customer. If not set, no account manager is set.
type (str) – Object type. If set to GROUP, this customer can have subcustomers. (default CUSTOMER)
features (list) – Features to enable on customer.
parentID (int) – ID of parent customer group to add this customer to. (default 0)
excludeFromProduction (bool) – Mark customer as excluded from production. (default false)
networkBaseCustomer (bool) – Whether enable customer as base customer for a customer group, used for remapping events’ customer by network CIDR among sub-customers that belong to same customer group (group must be SINGLE_NETWORK_DOMAIN flagged), cannot be set for group customer, and once enabled the customer cannot be promoted to group unless disable it. (default false)
singleNetworkDomain (bool) – Whether enable customer group option for remapping events’ customer by network CIDR among its sub-customers, cannot be set for non-group customer, and once enabled the customer group cannot be changed to non-group customer unless disable it. (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
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.customers.v1.customer.add_customer_service(customerID: int, service: 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 #
Add a service to a customer. (PUBLIC)
- Parameters
customerID (int) – Customer ID
service (str) – Name of service to enable on customer
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.customers.v1.customer.disable_customer(id: 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 #
Disable customer. (PUBLIC)
- Parameters
id (int) – Customer ID
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.customers.v1.customer.get_customer(idOrShortname: str, domain: str = None, skipServices: 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 a Customer identified by its ID. (PUBLIC)
- Parameters
idOrShortname (str) – Customer ID
domain (str) – Customer domain to lookup shortname (defaults to current users domain)
skipServices (bool) – Skip services in result (improves performance)
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.customers.v1.customer.get_customer_by_id(idOrShortname: str, domain: str = None, skipServices: 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 :
get_customer_by_id
is an alias forget_customer
. Exists only for backward compatibility - do not use - useget_customer
instead.
- argus_api.lib.customers.v1.customer.get_customer_by_shortname(idOrShortname: str, domain: str = None, skipServices: 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 :
get_customer_by_shortname
is an alias forget_customer
. Exists only for backward compatibility - do not use - useget_customer
instead.
- argus_api.lib.customers.v1.customer.get_customer_logo(idOrShortname: str, domain: str = None, size: str = None, includeDefault: bool = True, 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 #
Returns a Customer logo by customer shortname. (PUBLIC)
- Parameters
idOrShortname (str) – Customer ID or shortname
domain (str) – Customer domain to lookup shortname (defaults to current users domain)
size (str) – The preferred size of the logo (small, medium, large, xlarge). Will also crop the original logo if it is not a square (optional)
includeDefault (bool) – Include default logo
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
requests.Response
object
- argus_api.lib.customers.v1.customer.get_user_roles(idOrShortname: 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 a set of User roles for the customer id or shortname. (PUBLIC)
- Parameters
idOrShortname (str) – Customer ID or shortname
domain (str) – Customer domain to lookup 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 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.customers.v1.customer.list_customers(parentID: int = None, service: str = None, keywords: str = None, keywordField: str = None, sortBy: str = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, skipServices: 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 customers defined by query parameters (PUBLIC)
- Parameters
parentID (list) – Search by parentID
service (list) – Search by services
keywords (list) – Search by keywords
keywordField (list) – Set field strategy for keyword search
sortBy (list) – Sort search result
limit (int) – Maximum number of returned results
keywordMatch (str) – Set match strategy for keyword search
offset (int) – Skip a number of results
skipServices (bool) – Skip services in result (improves performance)
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.customers.v1.customer.move_customer(customer: str, domain: str = None, parent: 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 customer to a different parent. (PUBLIC)
- Parameters
customer (str) – Customer ID or shortname
domain (str) – ID or shortname of domain to lookup customer in
parent (str) – The name or ID of the new parent to move the customer to.
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.customers.v1.customer.reenable_customer(id: 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 #
Reenable customer. (PUBLIC)
- Parameters
id (int) – Customer ID
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.customers.v1.customer.remove_customer_service(customerID: int, service: 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 #
Remove a service from a customer. (PUBLIC)
- Parameters
customerID (int) – Customer ID
service (str) – Name of service to remove
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.customers.v1.customer.search_customers(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, parentID: int = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, service: str = None, domain: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, skipServices: 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 customers defined by CustomerSearchCriteria (PUBLIC)
- Parameters
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.
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.
parentID (list) – Search for customers by parent customer ID.
keywords (list) – Search for customers by keywords.
keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
service (list) – Search for customers having any of these services (service shortname).
domain (list) – Search for customers in one of these domains (by domain id or name).
sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
includeFlags (list) – Only include objects which have includeFlags set.
excludeFlags (list) – Exclude objects which have excludeFlags set.
skipServices (bool) – Whether to skip resolving service objects in the search results (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
ObjectNotFoundException – on 404
ValidationErrorException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.customers.v1.customer.update_customer(id: int, name: str = None, shortName: str = None, language: str = None, addProperties: dict = None, deleteProperties: str = None, logoURL: str = None, timeZone: str = None, accountManagerID: int = None, addFeatures: str = None, deleteFeatures: str = None, type: str = None, excludeFromProduction: bool = None, networkBaseCustomer: bool = None, singleNetworkDomain: bool = None, dataDeleted: 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 customer object. (PUBLIC)
- Parameters
id (int) – Customer ID
name (str) – If set, change customer name to this value. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
shortName (str) – If set, change customer shortname to this value (must be unique). => [a-zA-Z0-9_:\-.]*
language (str) – If set, change customer language.
addProperties (dict) – If set, add these properties. If the keys exist, they will be overwritten. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*
deleteProperties (list) – If set, remove properties with these keys. Missing keys are ignored.
logoURL (str) – If set, change customer logo. On format data:image/jpeg;base64,BASE64STRING. => Sanitize by regex data:.*
timeZone (str) – If set, change customer timezone to timezone with this name.
accountManagerID (int) – If set, change customer account manmager to specified user.
addFeatures (list) – If set, add these features to customer.
deleteFeatures (list) – If set, remove these features from customer.
type (str) – Customer type. If set to GROUP, this customer can have subcustomers.
excludeFromProduction (bool) – If set, enable/disable customer as excluded from production
networkBaseCustomer (bool) – If set, enable/disable customer as base customer for a customer group, used for remapping events’ customer by network CIDR among sub-customers that belong to same customer group (group must be SINGLE_NETWORK_DOMAIN flagged), cannot be set for group customer, and once enabled the customer cannot be promoted to group unless disable it.
singleNetworkDomain (bool) – If set, enable/disable customer group option for remapping events’ customer by network CIDR among its sub-customers, cannot be set for non-group customer, and once enabled the customer group cannot be changed to non-group customer unless disable it.
dataDeleted (bool) – If set, this option indicates that all of Customer data has been deleted. Please do not set this flag if you did not confirm that the customers data has been purged. Setting this option will not delete the data. It is for indication purposes only.
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.customers.v1.customer.update_user_roles(idOrShortname: str, domain: str = None, userRoles: 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 #
Update user roles of a customer object. (PUBLIC)
- Parameters
idOrShortname (str) – Customer ID or shortname
domain (str) – Customer domain to lookup user (defaults to current users domain)
userRoles (list) – Set of users and roles to update in json format
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